https://github.com/jamesmbaazam/rpkgdev
Provides resources and a compendium of commands (mostly from devtools and usethis) for developing R packages. Most of the commands come from Hadley's R Packages book.
https://github.com/jamesmbaazam/rpkgdev
Last synced: 2 months ago
JSON representation
Provides resources and a compendium of commands (mostly from devtools and usethis) for developing R packages. Most of the commands come from Hadley's R Packages book.
- Host: GitHub
- URL: https://github.com/jamesmbaazam/rpkgdev
- Owner: jamesmbaazam
- License: other
- Created: 2023-02-07T15:52:25.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-22T13:25:45.000Z (over 2 years ago)
- Last Synced: 2025-04-01T23:35:38.177Z (2 months ago)
- Homepage:
- Size: 461 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
Awesome Lists containing this project
README
---
output: github_document
link-citations: true
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%",
eval = FALSE
)
```
[](https://github.com/jamesmbaazam/RPkgDev/actions/workflows/R-CMD-check.yaml)
# _RPkgDev_: a compendium of resources for developing R packages
_RPkgDev_ provides a home for useful resources for developing R packages.
Here, we outline some of the most commonly used R helper commands (mostly from [devtools](https://devtools.r-lib.org/) and [usethis](https://usethis.r-lib.org/)).
The commands provided here are basically a summary of those outlined in
Hadley Wickham’s [R Packages 2e](https://r-pkgs.org/) book.
For more comprehensive explanations of the commands, please check their
help files or the R Packages book.
## Initial package setup
Set up the minimal package
```r
usethis::create_package()
```
Set up a script for your functions
```r
usethis::create_r()
```
Generate minimal documentation from your files
```r
devtools::document()
```
## Package files
### DESCRIPTION file
Add a package to “Imports” or “Suggests” with
`usethis::use_package()`. For example:
``` r
usethis::use_package('rmarkdown', type = 'Suggests')
```
In general, to order and format `DESCRIPTION` fields according to a fixed
standard, run
``` r
usethis::use_tidy_description()
```
### README
Use `.rmd` instead of `.md` for README
``` r
usethis::use_readme_rmd()
```
Build README.Rmd manually
``` r
devtools::build_readme()
```
Build README.Rmd with **Github Actions**
``` r
use_github_action("render-readme.yaml")
```
### Vignettes
Create a new `.rmd` file for a vignette
``` r
usethis::use_vignette("my_vignette")
```
## Building and checking the package
This is an iterative process during development.
Build and check package
``` r
devtools::check()
```
Check that the package uses all known best practices
``` r
goodpractice::gp()
```
Lint the package
``` r
lintr::lint_package()
```
## Package releases
Use the command below to increment the package version
``` r
usethis::use_version()
```
### Lifecycle
You can get much more detail in
``` r
vignette("stages", package = "lifecycle").
```
The lifecycle stage is often communicated through a badge. If you’d like
to use lifecycle badges, run the following to do some one-time setup:
``` r
usethis::use_lifecycle()
```
If you want to use a badge in README to indicate the lifecycle of an
entire package, call
``` r
usethis::use_lifecycle_badge()
```
If the lifecycle of a package is stable, it’s not really necessary to
use a badge, since that is the assumed default stage. Similarly, we
typically only use a badge for a function if its stage differs from that
of the associated package and likewise for an argument and the
associated function.
## Package website
To do the initial website setup, run
``` r
usethis::use_pkgdown()
```
To re-render your site locally, run
``` r
pkgdown::build_site()
```
## CRAN pre-release preparations
The following command adds an issue to your repo with a checklist of
tasks to complete before submitting to CRAN:
``` r
usethis::use_release_issue(version = NULL)
```