Skip to content

Mapping with R has been completely revamped. Check it out →

Package Development with R

README

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.

Have any questions? Put them below and we will help you out!

You need to be signed-in to comment on this post. Login.

Course Content

27 Lessons

devtools and usethis

Package names and authors

Choose a license

Setup git + GitHub

Writing functions

Adding functions to our package

Using other packages

Packages so good they get their own functions

Organizing .R files

roxygen2: In-Line Documentation for R

Argument descriptions and examples

Helper functions

Joining documentation

Unit tests for R

Organizing tests

Types of Test 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

Wrapping Up Package Development