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
README
This lesson is locked
This lesson is called README, part of the Package Development with R course. This lesson is called README, part of the Package Development with R course.
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.
Your Turn
Run use_readme_rmd() to setup a README. Knit the file and take a look.
Let’s add some badges.
Run use_lifecycle_badge(“experimental”) and use_cran_badge(). Then, re-knit.
Learn More
Chapter 18 of the R Packages book covers README files.
The article Building a Better README is here.
You need to be signed-in to comment on this post. Login.