https://github.com/jtr13/usethis_demos

tutorials and examples for usethis functions
https://github.com/jtr13/usethis_demos

Last synced: about 10 hours ago
JSON representation

tutorials and examples for usethis functions

• Host: GitHub
• URL: https://github.com/jtr13/usethis_demos
• Owner: jtr13
• Created: 2019-04-01T14:57:04.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-04-07T17:31:26.000Z (about 6 years ago)
• Last Synced: 2025-03-27T21:51:55.328Z (18 days ago)
• Language: R
• Size: 39.1 KB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - jtr13/usethis_demos - tutorials and examples for usethis functions (R)

README

        
# usethis_demos

tutorials and examples for usethis functions

[How to edit a pull request locally, part 1](https://github.com/jtr13/usethis_demos/blob/master/how_to1.md)

[How to edit a pull request locally, part 2](https://github.com/jtr13/usethis_demos/blob/master/how_to2.md)

Notes for contributors on rendering `.Rmd` files:

1. Update `usethis`.

1. Knit `how_to1.Rmd` with `rmarkdown::render("how_to1.Rmd", "github_document")`.

(Any uncommitted files will be committed during render.)

1. Delete `how_to1.html`  (I'm not sure how to stop `render()` from creating `html` previews.)

1. Make a change, save and commit.  Do NOT commit `how_to1.md`.

1. Remember the commit message.

1. Stage `how_to1.md`.

1. `git2r::stash()`.

1. Switch to `master` branch.

1. `git2r::stash_pop()`.  (`how_to1.md` should appear.)

1. Edit the commit message in the last paragraph of `how_to2.Rmd`.

1. Knit `how_to2.Rmd` by clicking Knit button. (Any uncommitted files will be committed during render.)

1. Commit, push changes.

1. `how_to2.html` file can be deleted.