EVOLUTION-MANAGER
Edit File: tidyverse.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Helpers for tidyverse development</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <link rel="stylesheet" type="text/css" href="R.css" /> </head><body> <table width="100%" summary="page for use_tidy_github_actions {usethis}"><tr><td>use_tidy_github_actions {usethis}</td><td style="text-align: right;">R Documentation</td></tr></table> <h2>Helpers for tidyverse development</h2> <h3>Description</h3> <p>These helpers follow tidyverse conventions which are generally a little stricter than the defaults, reflecting the need for greater rigor in commonly used packages. </p> <h3>Usage</h3> <pre> use_tidy_github_actions(ref = NULL) use_tidy_upkeep_issue(year = NULL) create_tidy_package(path, copyright_holder = NULL) use_tidy_description() use_tidy_dependencies() use_tidy_eval() use_tidy_contributing() use_tidy_support() use_tidy_issue_template() use_tidy_coc() use_tidy_github() use_tidy_style(strict = TRUE) </pre> <h3>Arguments</h3> <table summary="R argblock"> <tr valign="top"><td><code>ref</code></td> <td> <p>Desired Git reference, usually the name of a tag (<code>"v2"</code>) or branch (<code>"main"</code>). Other possibilities include a commit SHA (<code>"d1c516d"</code>) or <code>"HEAD"</code> (meaning "tip of remote's default branch"). If not specified, defaults to the latest published release of <code>r-lib/actions</code> (<a href="https://github.com/r-lib/actions/releases">https://github.com/r-lib/actions/releases</a>).</p> </td></tr> <tr valign="top"><td><code>year</code></td> <td> <p>Approximate year when you last touched this package. If <code>NULL</code>, the default, will give you a full set of actions to perform.</p> </td></tr> <tr valign="top"><td><code>path</code></td> <td> <p>A path. If it exists, it is used. If it does not exist, it is created, provided that the parent path exists.</p> </td></tr> <tr valign="top"><td><code>copyright_holder</code></td> <td> <p>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.</p> </td></tr> <tr valign="top"><td><code>strict</code></td> <td> <p>Boolean indicating whether or not a strict version of styling should be applied. See <code><a href="../../styler/html/tidyverse_style.html">styler::tidyverse_style()</a></code> for details.</p> </td></tr> </table> <h3>Details</h3> <ul> <li> <p><code>use_tidy_github_actions()</code>: Sets up the following workflows using <a href="https://github.com/features/actions">GitHub Actions</a>: </p> <ul> <li><p> Run <code style="white-space: pre;">R CMD check</code> on the current release, devel, and four previous versions of R. The build matrix also ensures <code style="white-space: pre;">R CMD check</code> is run at least once on each of the three major operating systems (Linux, macOS, and Windows). </p> </li> <li><p> Report test coverage. </p> </li> <li><p> Build and deploy a pkgdown site. </p> </li> <li><p> Provide two commands to be used in pull requests: <code style="white-space: pre;">/document</code> to run <code>roxygen2::roxygenise()</code> and update the PR, and <code style="white-space: pre;">/style</code> to run <code>styler::style_pkg()</code> and update the PR. </p> <p>This is how the tidyverse team checks its packages, but it is overkill for less widely used packages. Consider using the more streamlined workflows set up by <code><a href="github_actions.html">use_github_actions()</a></code> or <code><a href="github_actions.html">use_github_action_check_standard()</a></code>. </p> </li></ul> </li></ul> <ul> <li> <p><code>create_tidy_package()</code>: creates a new package, immediately applies as many of the tidyverse conventions as possible, issues a few reminders, and activates the new package. </p> </li> <li> <p><code>use_tidy_dependencies()</code>: sets up standard dependencies used by all tidyverse packages (except packages that are designed to be dependency free). </p> </li> <li> <p><code>use_tidy_description()</code>: puts fields in standard order and alphabetises dependencies. </p> </li> <li> <p><code>use_tidy_eval()</code>: imports a standard set of helpers to facilitate programming with the tidy eval toolkit. </p> </li> <li> <p><code>use_tidy_style()</code>: styles source code according to the <a href="https://style.tidyverse.org">tidyverse style guide</a>. This function will overwrite files! See below for usage advice. </p> </li> <li> <p><code>use_tidy_contributing()</code>: adds standard tidyverse contributing guidelines. </p> </li> <li> <p><code>use_tidy_issue_template()</code>: adds a standard tidyverse issue template. </p> </li> <li> <p><code>use_tidy_release_test_env()</code>: updates the test environment section in <code>cran-comments.md</code>. </p> </li> <li> <p><code>use_tidy_support()</code>: adds a standard description of support resources for the tidyverse. </p> </li> <li> <p><code>use_tidy_coc()</code>: equivalent to <code>use_code_of_conduct()</code>, but puts the document in a <code style="white-space: pre;">.github/</code> subdirectory. </p> </li> <li> <p><code>use_tidy_github()</code>: convenience wrapper that calls <code>use_tidy_contributing()</code>, <code>use_tidy_issue_template()</code>, <code>use_tidy_support()</code>, <code>use_tidy_coc()</code>. </p> </li> <li> <p><code><a href="use_github_labels.html">use_tidy_github_labels()</a></code> calls <code>use_github_labels()</code> to implement tidyverse conventions around GitHub issue label names and colours. </p> </li> <li> <p><code>use_tidy_upkeep_issue()</code> creates an issue containing a checklist of actions to bring your package up to current tidyverse standards. </p> </li></ul> <h3><code>use_tidy_style()</code></h3> <p>Uses the <a href="https://styler.r-lib.org">styler package</a> package to style all code in a package, project, or directory, according to the <a href="https://style.tidyverse.org">tidyverse style guide</a>. </p> <p><strong>Warning:</strong> 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. </p> <p>Invisibly returns a data frame with one row per file, that indicates whether styling caused a change. </p> <hr /><div style="text-align: center;">[Package <em>usethis</em> version 2.1.6 <a href="00Index.html">Index</a>]</div> </body></html>