Deploying to gh-pages from @ c75dd79 🚀

r-exts/Creating-R-packages.html

@@ -458,7 +458,7 @@ <h3 class="subsection anchored" data-number="1.1.1" data-anchor-id="the-descript
 <p>The <code>Biarch</code> logical field is used on Windows to select the <code>INSTALL</code> option <code>--force-biarch</code> for this package.</p>
 <div class="page-columns page-full"><p>The <code>BuildVignettes</code> logical field can be set to a false value to stop <code>R CMD build</code> from attempting to build the vignettes, as well as preventing<a href="#fn8" class="footnote-ref" id="fnref8" role="doc-noteref"><sup>8</sup></a> <code>R CMD check</code> from testing this. This should only be used exceptionally, for example if the PDFs include large figures which are not part of the package sources (and hence only in packages which do not have an Open Source license).</p><div class="no-row-height column-margin column-container"><li id="fn8"><p><sup>8</sup>&nbsp;But it is checked for Open Source packages by <code>R CMD check --as-cran</code>.</p></li></div></div>
 <p>The <code>VignetteBuilder</code> field names (in a comma-separated list) packages that provide an engine for building vignettes. These may include the current package, or ones listed in <code>Depends</code>, <code>Suggests</code> or <code>Imports</code>. The <strong>utils</strong> package is always implicitly appended. See <a href="#non-sweave-vignettes">Non-Sweave vignettes</a> for details. Note that if, for example, a vignette has engine <code>knitr::rmarkdown</code>, then <a href="https://CRAN.R-project.org/package=knitr"><strong>knitr</strong></a> provides the engine but both <strong>knitr</strong> and <a href="https://CRAN.R-project.org/package=rmarkdown"><strong>rmarkdown</strong></a> are needed for using it, so <em>both</em> these packages need to be in the <code>VignetteBuilder</code> field and at least suggested (as <strong>rmarkdown</strong> is only suggested by <strong>knitr</strong>, and hence not available automatically along with it). Many packages using <a href="https://CRAN.R-project.org/package=knitr"><strong>knitr</strong></a> also need the package <a href="https://CRAN.R-project.org/package=formatR"><strong>formatR</strong></a> which it suggests and so the user package needs to do so too and include this in <code>VignetteBuilder</code>.</p>
-<p>If the <code>DESCRIPTION</code> file is not entirely in ASCII it should contain an <code>Encoding</code> field specifying an encoding. This is used as the encoding of the <code>DESCRIPTION</code> file itself and of the <code>R</code> and <code>NAMESPACE</code> files, and as the default encoding of <code>.Rd</code> files. The examples are assumed to be in this encoding when running <code>R CMD check</code>, and it is used for the encoding of the <code>CITATION</code> file. Only encoding names <code>latin1</code>, <code>latin2</code> and <code>UTF-8</code> are known to be portable. (Do not specify an encoding unless one is actually needed: doing so makes the package <em>less</em> portable. If a package has a specified encoding, you should run <code>R CMD build</code> etc in a locale using that encoding.)</p>
+<p>If the <code>DESCRIPTION</code> file is not entirely in ASCII it should contain an <code>Encoding</code> field specifying an encoding. This is used as the encoding of the <code>DESCRIPTION</code> file itself and of the <code>R</code> and <code>NAMESPACE</code> files, and as the default encoding of <code>.Rd</code> files. The examples are assumed to be in this encoding when running <code>R CMD check</code>, and it is used for the encoding of the <code>CITATION</code> file. Only encoding names <code>latin1</code> and and <code>UTF-8</code> are known to be portable. (Do not specify an encoding unless one is actually needed: doing so makes the package <em>less</em> portable. If a package has a specified encoding, you should run <code>R CMD build</code> etc in a locale using that encoding.)</p>
 <p>The <code>NeedsCompilation</code> field should be set to <code>"yes"</code> if the package contains native code which needs to be compiled, otherwise <code>"no"</code> (when the package could be installed from source on any platform without additional tools). This is used by <code>install.packages(type = "both")</code> in R &gt;= 2.15.2 on platforms where binary packages are the norm: it is normally set by <code>R CMD build</code> or the repository assuming compilation is required if and only if the package has a <code>src</code> directory.</p>
 <p>The <code>OS_type</code> field specifies the OS(es) for which the package is intended. If present, it should be one of <code>unix</code> or <code>windows</code>, and indicates that the package can only be installed on a platform with <code>.Platform$OS.type</code> having that value.</p>
 <p>The <code>Type</code> field specifies the type of the package: see <a href="#package-types">Package types</a>.</p>