EVOLUTION-MANAGER
Edit File: rcmdcheck-config.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: rcmdcheck configuration</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 rcmdcheck-config {rcmdcheck}"><tr><td>rcmdcheck-config {rcmdcheck}</td><td style="text-align: right;">R Documentation</td></tr></table> <h2>rcmdcheck configuration</h2> <h3>Description</h3> <p>Options take precedence over environment variables. E.g. if both the <code>RCMDCHECK_NUM_COLORS</code> environment variables and the <code>rcmdcheck.num_colors</code> option are set, then the latter is used. </p> <h3>Details</h3> <p>rcmdcheck uses the cli package for much of its output, so you can configure the output via cli, see <a href="../../cli/html/cli-config.html">cli::cli-config</a>. </p> <p>Package configration is defined in the <code>DESCRIPTION</code> file of the checked package. E.g.:</p> <pre>Config/build/clean-inst-doc: FALSE </pre> <h3>Environment variables</h3> <ul> <li> <p><code>R_PROFILE_USER</code>: standard R environment variable to configure the path to the user level R profile. See <a href="../../base/html/Startup.html">base::R_PROFILE_USER</a>. </p> </li> <li> <p><code>RCMDCHECK_BASE_URL</code>: URL to the root of the CRAN check web page. You can use this to select an alternative CRAN mirror. Defaults to <code style="white-space: pre;">https://cran.r-project.org/web/checks/</code>. </p> </li> <li> <p><code>RCMDCHECK_DETAILS_URL</code>: URL to the root of the CRAN check output page. Defaults to <code style="white-space: pre;">https://www.r-project.org/nosvn/R.check/</code>. </p> </li> <li> <p><code>RCMDCHECK_ERROR_ON</code>: the default value for the <code>error_on</code> argument of <code><a href="rcmdcheck.html">rcmdcheck()</a></code>. </p> </li> <li> <p><code>RCMDCHECK_FLAVOURS_URL</code> URL to the CRAN check flavours page. You can use this to select an alternative CRAN mirror. Defaults to <code style="white-space: pre;">https://cran.r-project.org/web/checks/check_flavors.html</code>. </p> </li> <li> <p><code>RCMDCHECK_NUM_COLORS</code>: the number of ANSI colors to use in the output. It can be used to override the number of colors detected or configured by the cli package. See <code><a href="../../cli/html/num_ansi_colors.html">cli::num_ansi_colors()</a></code>. This configuration is only used for the output of rcmdcheck and it does not affect the examples and test cases (and other code) of the checked package. It not set, then the default of cli is uesed. The corresponding option is <code>rcmdcheck.num_colors</code>. </p> </li> <li> <p><code>RCMDCHECK_TIMESTAMP_LIMIT</code>: lower limit is seconds, above which rcmdcheck adds time stamps to the individual check steps. It may be fractional. Defaults to 1/3 of a second. The corresponding option is <code>rcmdcheck.timestamp_limit</code>. </p> </li> <li> <p><code>RCMDCHECK_USE_RSTUDIO_PANDOC</code>: Flag (<code>true</code> or <code>false</code>). If <code>true</code>, then rcmdcheck <em>always</em> puts RStudio's pandoc (if available) on the path. If <code>false</code>, then it <em>never</em> does that. If not set, or set to a different value, then pandoc is put on the path only if it is not already available. RStudio's pandoc is detected via an <code>RSTUDIO_PANDOC</code> environment variable. </p> </li> <li> <p><code>RCMDCHECK_LOAD_CHECK_ENV</code>: you can use this environment variable suppress loading environment variables from the <code>tools/check.env</code> file. See <code><a href="rcmdcheck.html">rcmdcheck()</a></code> for details. </p> </li> <li> <p><code>RSTUDIO_PANDOC</code>: if set, rcmdcheck adds this environment variable to the PATH if pandoc is not on the PATH already. It is usually set in RStudio. See also the <code>RCMDCHECK_USE_RSTUDIO_PANDOC</code> environment variable. </p> </li></ul> <h3>Options</h3> <ul> <li> <p><code>rcmdcheck.num_colors</code>: the number of ANSI colors to use in the output. It can be used to override the number of colors detected or configured by the cli package. See <code><a href="../../cli/html/num_ansi_colors.html">cli::num_ansi_colors()</a></code>. This configuration is only used for the output of rcmdcheck and it does not affect the examples and test cases (and other code) of the checked package. It not set, then the default of cli is uesed. The corresponding environment variable is <code>RCMDCHECK_NUM_COLORS</code>. </p> </li> <li> <p><code>rcmdcheck.test_output</code>: Flag (<code>TRUE</code> or <code>FALSE</code>), whether <code><a href="print.rcmdcheck.html">print.rcmdcheck()</a></code> should print the full test output if there are no test failures. If some tests fail, then only the failures are printed, independently of this option. </p> </li> <li> <p><code>rcmdcheck.timestamp_limit</code>: lower limit is seconds, above which rcmdcheck adds time stamps to the individual check steps. It may be fractional. Defaults to 1/3 of a second. The corresponding environment variable is <code>RCMDCHECK_TIMESTAMP_LIMIT</code>. </p> </li></ul> <h3>Package configuration:</h3> <ul> <li> <p><code>Config/build/clean-inst-doc</code>: Flag (<code>TRUE</code> or <code>FALSE</code>) to specify if the <code>inst/doc</code> directory should be cleaned up when building a package directory. If not specified, then <code>NULL</code> is used. See the <code>clean_doc</code> option of <code><a href="../../pkgbuild/html/build.html">pkgbuild::build()</a></code> for more details. </p> </li></ul> <hr /><div style="text-align: center;">[Package <em>rcmdcheck</em> version 1.4.0 <a href="00Index.html">Index</a>]</div> </body></html>