usethis: tidyverse – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

tidyverse

Helpers for tidyverse development

Description

These helpers follow tidyverse conventions which are generally a little stricter than the defaults, reflecting the need for greater rigor in commonly used packages.

Usage

use_tidy_github_actions()

create_tidy_package(path, copyright_holder = NULL)

use_tidy_description()

use_tidy_eval()

use_tidy_contributing()

use_tidy_support()

use_tidy_issue_template()

use_tidy_coc()

use_tidy_github()

use_tidy_style(strict = TRUE)

use_tidy_release_test_env()

Arguments

`path`	A path. If it exists, it is used. If it does not exist, it is created, provided that the parent path exists.
`copyright_holder`	Name of the copyright holder or holders. This defaults to "package name authors"; you should only change this if you use a CLA to assign copyright to a single entity.
`strict`	Boolean indicating whether or not a strict version of styling should be applied. See `styler::tidyverse_style()` for details.

Details

use_tidy_github_actions(): Sets up the following workflows using GitHub Actions:
- Run R CMD check on the current release, devel, and four previous versions of R.
- Report test coverage.
- Build and deploy a pkgdown site.
- Provide two commands to be used in pull requests: /document to run roxygen2::roxygenise() and update the PR, and /style to run styler::style_pkg() and update the PR.

create_tidy_package(): creates a new package, immediately applies as many of the tidyverse conventions as possible, issues a few reminders, and activates the new package.
use_tidy_description(): puts fields in standard order and alphabetises dependencies.
use_tidy_eval(): imports a standard set of helpers to facilitate programming with the tidy eval toolkit.
use_tidy_style(): styles source code according to the tidyverse style guide. This function will overwrite files! See below for usage advice.
use_tidy_contributing(): adds standard tidyverse contributing guidelines.
use_tidy_issue_template(): adds a standard tidyverse issue template.
use_tidy_release_test_env(): updates the test environment section in cran-comments.md.
use_tidy_support(): adds a standard description of support resources for the tidyverse.
use_tidy_coc(): equivalent to use_code_of_conduct(), but puts the document in a .github/ subdirectory.
use_tidy_github(): convenience wrapper that calls use_tidy_contributing(), use_tidy_issue_template(), use_tidy_support(), use_tidy_coc().

`use_tidy_style()`

Uses the styler package package to style all code in a package, project, or directory, according to the tidyverse style guide.

Warning: This function will overwrite files! It is strongly suggested to only style files that are under version control or to first create a backup copy.

Invisibly returns a data frame with one row per file, that indicates whether styling caused a change.

usethis

Automate Package and Project Setup

v2.0.1

MIT + file LICENSE

Authors

Hadley Wickham [aut] (<https://orcid.org/0000-0003-4757-117X>), Jennifer Bryan [aut, cre] (<https://orcid.org/0000-0002-6983-2759>), RStudio [cph, fnd]

Initial release