Get access to all lessons in this course.
-
Setup packages
- devtools and usethis
- Package names and authors
- Choose a license
- Setup git + GitHub
-
Write code
- Writing functions
- Adding functions to our package
- Using other packages
- Packages so good they get their own functions
- Organizing .R files
-
Document
- roxygen2: In-Line Documentation for R
- Argument descriptions and examples
- Helper functions
- Joining documentation
-
Test
- Unit tests for R
- Organizing tests
- R CMD Check
- Types of Test Files
- Test Coverage
-
Teach
- Examples
- README
- Spellcheck
-
Add data and files
- Store data and files
- Include data for tests and create RMarkdown templates
- Create other templates
- Launch and store Shiny apps
- Citations, ignoring files, and including add-ins
Package Development with R
roxygen2: In-Line Documentation for R
This lesson is locked
This lesson is called roxygen2: In-Line Documentation for R, part of the Package Development with R course. This lesson is called roxygen2: In-Line Documentation for R, part of the Package Development with R course.
If the video is not playing correctly, you can watch it in a new window
Transcript
Click on the transcript to go to that point in the video. Please note that transcripts are auto generated and may contain minor inaccuracies.
For this section of the course, you’ll need the materials in this GitHub repo. You can download or clone them. After you download or clone the materials from the GitHub repo for this section of the course, open the entire project by clicking 03_avalanchr.Rproj.
Your Turn
Open the NAMESPACE file. What do you see?
Let’s add documentation. Run use_roxygen_md()
Open r/themes.R. Insert a roxygen skeleton for theme_avalanche().
Change the title to “AVALANCHE ggplot2 themes”
Hit Enter/Return twice after the title. Make sure the new lines start with #’.
Add this text: “Minimalistic ggplot themes for use on AVALANCHE reports.”Run document() or press Ctrl/Cmd + Shift + D.
Read the help page for your function with ?theme_avalanche.Finally, look at the NAMESPACE file again. What changed?
Learn More
The R Packages book has a chapter on adding documentation. You might also be interested in the Getting Started with roxygen2 vignette.
You need to be signed-in to comment on this post. Login.