Skip to content

Commit

Permalink
Built site for gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
@Baltmann01
Baltmann01 committed Oct 11, 2024
1 parent 6ca5fae commit 302c018
Show file tree
Hide file tree
Showing 7 changed files with 181 additions and 33 deletions.
2 changes: 1 addition & 1 deletion .nojekyll
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
c321afea
b9800767
57 changes: 29 additions & 28 deletions about.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -297,63 +297,64 @@ <h3 class="anchored" data-anchor-id="session-info">Session info</h3>
<div class="cell-output cell-output-stdout">
<pre><code>─ Session info ───────────────────────────────────────────────────────────────
setting value
version R version 4.4.1 (2024-06-14 ucrt)
os Windows 10 x64 (build 19045)
system x86_64, mingw32
ui RTerm
version R version 4.4.0 (2024-04-24)
os macOS Ventura 13.6.9
system x86_64, darwin20
ui X11
language (EN)
collate German_Austria.utf8
ctype German_Austria.utf8
tz Europe/Vienna
date 2024-10-03
pandoc 3.2 @ C:\\Users\\benia\\AppData\\Local\\Programs\\Quarto\\bin\\tools/ (via rmarkdown)
collate en_US.UTF-8
ctype en_US.UTF-8
tz America/New_York
date 2024-09-26
pandoc NA (via rmarkdown)

─ Packages ───────────────────────────────────────────────────────────────────
! package * version date (UTC) lib source
P cachem 1.1.0 2024-05-16 [?] RSPM
P cli 3.6.3 2024-06-21 [?] RSPM
P devtools * 2.4.5 2022-10-11 [?] CRAN (R 4.4.1)
P devtools * 2.4.5 2022-10-11 [?] RSPM
P digest 0.6.36 2024-06-23 [?] RSPM
P ellipsis 0.3.2 2021-04-29 [?] CRAN (R 4.4.1)
P ellipsis 0.3.2 2021-04-29 [?] RSPM
P evaluate 0.24.0 2024-06-10 [?] RSPM
P fastmap 1.2.0 2024-05-15 [?] RSPM
P fs 1.6.4 2024-04-25 [?] RSPM
P glue 1.7.0 2024-01-09 [?] RSPM
P htmltools 0.5.8.1 2024-04-04 [?] RSPM
P htmlwidgets 1.6.4 2023-12-06 [?] CRAN (R 4.4.1)
P httpuv 1.6.15 2024-03-26 [?] CRAN (R 4.4.1)
P htmlwidgets 1.6.4 2023-12-06 [?] RSPM
P httpuv 1.6.15 2024-03-26 [?] RSPM
P jsonlite 1.8.8 2023-12-04 [?] RSPM
P knitr 1.48 2024-07-07 [?] CRAN (R 4.4.1)
P later 1.3.2 2023-12-06 [?] CRAN (R 4.4.1)
P knitr 1.48 2024-07-07 [?] RSPM
P later 1.3.2 2023-12-06 [?] RSPM
P lifecycle 1.0.4 2023-11-07 [?] RSPM
P magrittr 2.0.3 2022-03-30 [?] RSPM
P memoise 2.0.1 2021-11-26 [?] RSPM
P mime 0.12 2021-09-28 [?] RSPM
P miniUI 0.1.1.1 2018-05-18 [?] CRAN (R 4.4.1)
P pkgbuild 1.4.4 2024-03-17 [?] CRAN (R 4.4.0)
P pkgload 1.4.0 2024-06-28 [?] CRAN (R 4.4.1)
P profvis 0.3.8 2023-05-02 [?] CRAN (R 4.4.1)
P promises 1.3.0 2024-04-05 [?] CRAN (R 4.4.1)
P purrr 1.0.2 2023-08-10 [?] CRAN (R 4.4.0)
P miniUI 0.1.1.1 2018-05-18 [?] RSPM
P pkgbuild 1.4.4 2024-03-17 [?] RSPM
P pkgload 1.4.0 2024-06-28 [?] RSPM
P profvis 0.3.8 2023-05-02 [?] RSPM
P promises 1.3.0 2024-04-05 [?] RSPM
P purrr 1.0.2 2023-08-10 [?] RSPM
P R6 2.5.1 2021-08-19 [?] RSPM
P Rcpp 1.0.13 2024-07-17 [?] RSPM
P remotes 2.5.0 2024-03-17 [?] CRAN (R 4.4.1)
P remotes 2.5.0 2024-03-17 [?] RSPM
renv 1.0.7 2024-04-11 [1] RSPM (R 4.4.0)
P rlang 1.1.4 2024-06-04 [?] RSPM
P rmarkdown 2.27 2024-05-17 [?] RSPM
P sessioninfo 1.2.2 2021-12-06 [?] CRAN (R 4.4.1)
P rstudioapi 0.16.0 2024-03-24 [?] RSPM
P sessioninfo 1.2.2 2021-12-06 [?] RSPM
P shiny 1.9.1 2024-08-01 [?] RSPM
P stringi 1.8.4 2024-05-06 [?] RSPM
P stringr 1.5.1 2023-11-14 [?] RSPM
P urlchecker 1.0.1 2021-11-30 [?] CRAN (R 4.4.1)
P urlchecker 1.0.1 2021-11-30 [?] RSPM
P usethis * 3.0.0 2024-07-29 [?] RSPM
P vctrs 0.6.5 2023-12-01 [?] RSPM
P xfun 0.46 2024-07-18 [?] RSPM
P xtable 1.8-4 2019-04-21 [?] CRAN (R 4.4.1)
P yaml 2.3.10 2024-07-26 [?] RSPM
P xtable 1.8-4 2019-04-21 [?] RSPM
P yaml 2.3.8 2023-12-11 [?] RSPM

[1] C:/Users/benia/Desktop/cran-cookbook/cran-cookbook/website/renv/library/windows/R-4.4/x86_64-w64-mingw32
[2] C:/Users/benia/AppData/Local/R/cache/R/renv/sandbox/windows/R-4.4/x86_64-w64-mingw32/e0da0d43
[1] /Users/jasminedaly/Desktop/R-directory/cran-cookbook/website/renv/library/macos/R-4.4/x86_64-apple-darwin20
[2] /Users/jasminedaly/Library/Caches/org.R-project.R/R/renv/sandbox/macos/R-4.4/x86_64-apple-darwin20/2edc1867

P ── Loaded and on-disk path mismatch.

Expand Down
41 changes: 41 additions & 0 deletions code_issues.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,14 @@ <h2 id="toc-title">On this page</h2>
<li><a href="#details-6" id="toc-details-6" class="nav-link" data-scroll-target="#details-6">Details</a></li>
</ul></li>
</ul></li>
<li><a href="#setting-optionswarn--1" id="toc-setting-optionswarn--1" class="nav-link" data-scroll-target="#setting-optionswarn--1">Setting <code>options(warn = -1)</code></a>
<ul class="collapse">
<li><a href="#problem-7" id="toc-problem-7" class="nav-link" data-scroll-target="#problem-7">Problem</a></li>
<li><a href="#solution-7" id="toc-solution-7" class="nav-link" data-scroll-target="#solution-7">Solution</a>
<ul class="collapse">
<li><a href="#details-7" id="toc-details-7" class="nav-link" data-scroll-target="#details-7">Details</a></li>
</ul></li>
</ul></li>
</ul>
</nav>
</div>
Expand Down Expand Up @@ -665,6 +673,39 @@ <h3 class="anchored" data-anchor-id="details-6">Details</h3>
<p>… so do not use it to find out if a named package is installed (use <code>find.package</code> or <code>system.file</code>) nor to find out if a package is usable (call <code>requireNamespace</code> or <code>require</code> and check the return value) nor to find details of a small number of packages (use <code>packageDescription</code>).</p>
</blockquote>
<p>Ideally, use <code>requireNamespace("pkg")</code> or <code>require("pkg")</code>, both return <code>FALSE</code> if a package isn’t available, and throw an error conditionally. For more details on package installations in your code see <a href="">the corresponding recipe, (yet to come)</a>.</p>
<hr>
</section>
</section>
</section>
<section id="setting-optionswarn--1" class="level1">
<h1>Setting <code>options(warn = -1)</code></h1>
<section id="problem-7" class="level2">
<h2 class="anchored" data-anchor-id="problem-7">Problem</h2>
<p>You are setting <code>options(warn = -1)</code>.</p>
</section>
<section id="solution-7" class="level2">
<h2 class="anchored" data-anchor-id="solution-7">Solution</h2>
<p>Consider using <code>suppressWarnings()</code> instead of <code>options(warn = -1)</code> if you absolutely need to suppress warnings.</p>
<section id="details-7" class="level3">
<h3 class="anchored" data-anchor-id="details-7">Details</h3>
<div class="callout callout-style-simple callout-note no-icon callout-titled" title="CRAN Review Communication">
<div class="callout-header d-flex align-content-center" data-bs-toggle="collapse" data-bs-target=".callout-10-contents" aria-controls="callout-10" aria-expanded="false" aria-label="Toggle callout">
<div class="callout-icon-container">
<i class="callout-icon no-icon"></i>
</div>
<div class="callout-title-container flex-fill">
CRAN Review Communication
</div>
<div class="callout-btn-toggle d-inline-block border-0 py-1 ps-1 pe-0 float-end"><i class="callout-toggle"></i></div>
</div>
<div id="callout-10" class="callout-10-contents callout-collapse collapse">
<div class="callout-body-container callout-body">
<p>You are setting <code>options(warn=-1)</code> in your function. This is not allowed. Please rather use <code>suppressWarnings()</code> if really needed.</p>
</div>
</div>
</div>
<p>CRAN doesn’t allow negative <code>warn</code> options. This setting will turn off all warning messages. Even if the settings are correctly restored, as explained in the <a href="#change-of-options-graphical-parameters-and-working-directory">Change of Options recipe</a>, the submission will be rejected.</p>
<p>CRAN recommends using <code>suppressWarnings()</code>, which disables warnings only for the specific expression it’s applied to, rather than globally.</p>


</section>
Expand Down
46 changes: 46 additions & 0 deletions description_issues.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,14 @@ <h2 id="toc-title">On this page</h2>
<li><a href="#details-4" id="toc-details-4" class="nav-link" data-scroll-target="#details-4">Details</a></li>
</ul></li>
</ul></li>
<li><a href="#references" id="toc-references" class="nav-link" data-scroll-target="#references">References</a>
<ul class="collapse">
<li><a href="#problem-5" id="toc-problem-5" class="nav-link" data-scroll-target="#problem-5">Problem</a></li>
<li><a href="#solution-5" id="toc-solution-5" class="nav-link" data-scroll-target="#solution-5">Solution</a>
<ul class="collapse">
<li><a href="#details-5" id="toc-details-5" class="nav-link" data-scroll-target="#details-5">Details</a></li>
</ul></li>
</ul></li>
</ul>
</nav>
</div>
Expand Down Expand Up @@ -407,6 +415,44 @@ <h3 class="anchored" data-anchor-id="details-4">Details</h3>
<p>If your package uses the older approach of specifying Maintainer and Author separately in the DESCRIPTION file, it won’t be rejected for that reason alone. However, this method is discouraged, and any manual modifications that differ from the auto-generated fields will result in automatic rejection by CRAN.</p>
</div>
</div>
<hr>
</section>
</section>
</section>
<section id="references" class="level1">
<h1>References</h1>
<section id="problem-5" class="level2">
<h2 class="anchored" data-anchor-id="problem-5">Problem</h2>
<p>The reference link in the Description field is incorrectly formatted or isn’t clickable.</p>
</section>
<section id="solution-5" class="level2">
<h2 class="anchored" data-anchor-id="solution-5">Solution</h2>
<p>Remove the space after &lt;doi:…&gt; or &lt;https:…&gt; to enable the reference link. Write the reference in the form: Authors (year) &lt;doi:…&gt;.</p>
<section id="details-5" class="level3">
<h3 class="anchored" data-anchor-id="details-5">Details</h3>
<p>Ideally, each package should include at least one reference in the description text to help users further explore the theory behind the package. These references should be formatted as shown in the <a href="https://github.com/RcppCore/Rcpp/blob/master/DESCRIPTION#L21-L29">‘Rcpp’</a> package:</p>
<pre><code>Description: The 'Rcpp' package provides R functions as well as C++ classes which
offer a seamless integration of R and C++. Many R data types and objects can be
mapped back and forth to C++ equivalents which facilitates both writing of new
code as well as easier integration of third-party libraries. Documentation
about 'Rcpp' is provided by several vignettes included in this package, via the
'Rcpp Gallery' site at &lt;https://gallery.rcpp.org&gt;, the paper by Eddelbuettel and
Francois (2011, &lt;doi:10.18637/jss.v040.i08&gt;), the book by Eddelbuettel (2013,
&lt;doi:10.1007/978-1-4614-6868-4&gt;) and the paper by Eddelbuettel and Balamuta (2018,
&lt;doi:10.1080/00031305.2017.1375990&gt;); see 'citation("Rcpp")' for details.</code></pre>
<div class="callout callout-style-default callout-tip callout-titled">
<div class="callout-header d-flex align-content-center">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<div class="callout-title-container flex-fill">
Tip
</div>
</div>
<div class="callout-body-container callout-body">
<p>Including a reference in the Description field is optional, and your package will not be archived if one is missing. You can also use the <a href="https://usethis.r-lib.org/reference/use_cran_comments.html">cran-comments.md</a> file to provide additional references or information.</p>
</div>
</div>


</section>
Expand Down
20 changes: 20 additions & 0 deletions general_issues.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ <h2 id="toc-title">On this page</h2>
<li><a href="#description-length" id="toc-description-length" class="nav-link" data-scroll-target="#description-length">Description Length</a></li>
</ul></li>
<li><a href="#structuring-of-examples" id="toc-structuring-of-examples" class="nav-link" data-scroll-target="#structuring-of-examples">Structuring of Examples</a></li>
<li><a href="#package-size" id="toc-package-size" class="nav-link" data-scroll-target="#package-size">Package Size</a></li>
</ul>
</nav>
</div>
Expand Down Expand Up @@ -279,6 +280,25 @@ <h1>Structuring of Examples</h1>
<p>All wrappers must still be placed inside the <code>\examples{}</code> tag.</p>
</div>
</div>
</section>
<section id="package-size" class="level1">
<h1>Package Size</h1>
<p>Ideally, CRAN packages should be under 5 Mb. There are <em>very few exceptions</em> mostly for a larger <code>inst/</code> folder (and these will trigger flags for every future submission). They must be approved by a CRAN team member and since every accepted version is saved on CRAN, they are very hesitant.</p>
<p>It’s best to minimize the package size. Large datasets can be hosted externally, such as on GitHub, and downloaded when necessary. Consider placing them in a separate data package that requires less frequent updates.</p>
<p>At a upper limit of the package tarball the CRAN policy states 10 Mb. It is recommended to include third-party source software within the package. If that requires larger tarballs, a modestly increased limit can be requested at submission.</p>
<div class="callout callout-style-default callout-tip callout-titled">
<div class="callout-header d-flex align-content-center">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<div class="callout-title-container flex-fill">
Tip
</div>
</div>
<div class="callout-body-container callout-body">
<p>If your package exceeds the recommended 5 Mb limit, it will generate a NOTE in the R CMD Check. You can explain why the size is okay by providing details in the <a href="https://usethis.r-lib.org/reference/use_cran_comments.html">cran-comments.md</a> file.</p>
</div>
</div>


</section>
Expand Down
Loading

0 comments on commit 302c018

Please sign in to comment.