diff --git a/.nojekyll b/.nojekyll index 0ec5f64..50efc0e 100644 --- a/.nojekyll +++ b/.nojekyll @@ -1 +1 @@ -c321afea \ No newline at end of file +b9800767 \ No newline at end of file diff --git a/about.html b/about.html index 09450da..8003b8a 100644 --- a/about.html +++ b/about.html @@ -297,63 +297,64 @@

Session info

─ 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.
 
diff --git a/code_issues.html b/code_issues.html
index 0510b4c..57f71cf 100644
--- a/code_issues.html
+++ b/code_issues.html
@@ -264,6 +264,14 @@ 
On this page

   
  • Details
    • 
   
   
+  
  • Setting options(warn = -1)
+  
    •
    @@ -665,6 +673,39 @@

    Details

    … so do not use it to find out if a named package is installed (use find.package or system.file) nor to find out if a package is usable (call requireNamespace or require and check the return value) nor to find details of a small number of packages (use packageDescription).

    Ideally, use requireNamespace("pkg") or require("pkg"), both return FALSE if a package isn’t available, and throw an error conditionally. For more details on package installations in your code see the corresponding recipe, (yet to come).

    +
    + + + +
    +

    Setting options(warn = -1)

    +
    +

    Problem

    +

    You are setting options(warn = -1).

    +
    +
    +

    Solution

    +

    Consider using suppressWarnings() instead of options(warn = -1) if you absolutely need to suppress warnings.

    +
    +

    Details

    +
    + +
    +
    +

    You are setting options(warn=-1) in your function. This is not allowed. Please rather use suppressWarnings() if really needed.

    +
    +
    +
    +

    CRAN doesn’t allow negative warn options. This setting will turn off all warning messages. Even if the settings are correctly restored, as explained in the Change of Options recipe, the submission will be rejected.

    +

    CRAN recommends using suppressWarnings(), which disables warnings only for the specific expression it’s applied to, rather than globally.

    diff --git a/description_issues.html b/description_issues.html index 0d12808..2e6db96 100644 --- a/description_issues.html +++ b/description_issues.html @@ -247,6 +247,14 @@

    On this page

  • Details
    • +
  • References +
    • @@ -407,6 +415,44 @@

    Details

    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.

    +
    +
    +
    + +
    +

    References

    +
    +

    Problem

    +

    The reference link in the Description field is incorrectly formatted or isn’t clickable.

    +
    +
    +

    Solution

    +

    Remove the space after <doi:…> or <https:…> to enable the reference link. Write the reference in the form: Authors (year) <doi:…>.

    +
    +

    Details

    +

    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 ‘Rcpp’ package:

    +
    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 <https://gallery.rcpp.org>, the paper by Eddelbuettel and
+ Francois (2011, <doi:10.18637/jss.v040.i08>), the book by Eddelbuettel (2013,
+ <doi:10.1007/978-1-4614-6868-4>) and the paper by Eddelbuettel and Balamuta (2018,
+ <doi:10.1080/00031305.2017.1375990>); see 'citation("Rcpp")' for details.
    +
    +
    +
    + +
    +
    +Tip +
    +
    +
    +

    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 cran-comments.md file to provide additional references or information.

    +
    +
    diff --git a/general_issues.html b/general_issues.html index f133358..593a08e 100644 --- a/general_issues.html +++ b/general_issues.html @@ -179,6 +179,7 @@

    On this page

  • Description Length
  • Structuring of Examples
    • +
  • Package Size
    • @@ -279,6 +280,25 @@

    Structuring of Examples

    All wrappers must still be placed inside the \examples{} tag.

    +
    +
    +

    Package Size

    +

    Ideally, CRAN packages should be under 5 Mb. There are very few exceptions mostly for a larger inst/ 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.

    +

    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.

    +

    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.

    +
    +
    +
    + +
    +
    +Tip +
    +
    +
    +

    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 cran-comments.md file.

    +
    +
    diff --git a/search.json b/search.json index 1224dda..d1c1c5d 100644 --- a/search.json +++ b/search.json @@ -209,6 +209,26 @@ "Code Issues" ] }, + { + "objectID": "code_issues.html#problem-7", + "href": "code_issues.html#problem-7", + "title": "Code Issues", + "section": "Problem", + "text": "Problem\nYou are setting options(warn = -1).", + "crumbs": [ + "Code Issues" + ] + }, + { + "objectID": "code_issues.html#solution-7", + "href": "code_issues.html#solution-7", + "title": "Code Issues", + "section": "Solution", + "text": "Solution\nConsider using suppressWarnings() instead of options(warn = -1) if you absolutely need to suppress warnings.\n\nDetails\n\n\n\n\n\n\nCRAN Review Communication\n\n\n\n\n\nYou are setting options(warn=-1) in your function. This is not allowed. Please rather use suppressWarnings() if really needed.\n\n\n\nCRAN doesn’t allow negative warn options. This setting will turn off all warning messages. Even if the settings are correctly restored, as explained in the Change of Options recipe, the submission will be rejected.\nCRAN recommends using suppressWarnings(), which disables warnings only for the specific expression it’s applied to, rather than globally.", + "crumbs": [ + "Code Issues" + ] + }, { "objectID": "about.html", "href": "about.html", @@ -244,7 +264,7 @@ "href": "about.html#technical-details", "title": "About", "section": "Technical details", - "text": "Technical details\nThis cookbook is a Quarto website. To learn more about Quarto websites visit https://quarto.org/docs/websites. The cookbook is hosted on GitHub pages as part of the Community R development resources. The website is currently deployed with local commands.\n\nSession info\n\nif (!requireNamespace(\"devtools\", quietly = TRUE)) {\n install.packages(\"devtools\")\n}\nlibrary(devtools)\n\nLoading required package: usethis\n\ndevtools::session_info()\n\n─ Session info ───────────────────────────────────────────────────────────────\n setting value\n version R version 4.4.1 (2024-06-14 ucrt)\n os Windows 10 x64 (build 19045)\n system x86_64, mingw32\n ui RTerm\n language (EN)\n collate German_Austria.utf8\n ctype German_Austria.utf8\n tz Europe/Vienna\n date 2024-10-03\n pandoc 3.2 @ C:\\\\Users\\\\benia\\\\AppData\\\\Local\\\\Programs\\\\Quarto\\\\bin\\\\tools/ (via rmarkdown)\n\n─ Packages ───────────────────────────────────────────────────────────────────\n ! package * version date (UTC) lib source\n P cachem 1.1.0 2024-05-16 [?] RSPM\n P cli 3.6.3 2024-06-21 [?] RSPM\n P devtools * 2.4.5 2022-10-11 [?] CRAN (R 4.4.1)\n P digest 0.6.36 2024-06-23 [?] RSPM\n P ellipsis 0.3.2 2021-04-29 [?] CRAN (R 4.4.1)\n P evaluate 0.24.0 2024-06-10 [?] RSPM\n P fastmap 1.2.0 2024-05-15 [?] RSPM\n P fs 1.6.4 2024-04-25 [?] RSPM\n P glue 1.7.0 2024-01-09 [?] RSPM\n P htmltools 0.5.8.1 2024-04-04 [?] RSPM\n P htmlwidgets 1.6.4 2023-12-06 [?] CRAN (R 4.4.1)\n P httpuv 1.6.15 2024-03-26 [?] CRAN (R 4.4.1)\n P jsonlite 1.8.8 2023-12-04 [?] RSPM\n P knitr 1.48 2024-07-07 [?] CRAN (R 4.4.1)\n P later 1.3.2 2023-12-06 [?] CRAN (R 4.4.1)\n P lifecycle 1.0.4 2023-11-07 [?] RSPM\n P magrittr 2.0.3 2022-03-30 [?] RSPM\n P memoise 2.0.1 2021-11-26 [?] RSPM\n P mime 0.12 2021-09-28 [?] RSPM\n P miniUI 0.1.1.1 2018-05-18 [?] CRAN (R 4.4.1)\n P pkgbuild 1.4.4 2024-03-17 [?] CRAN (R 4.4.0)\n P pkgload 1.4.0 2024-06-28 [?] CRAN (R 4.4.1)\n P profvis 0.3.8 2023-05-02 [?] CRAN (R 4.4.1)\n P promises 1.3.0 2024-04-05 [?] CRAN (R 4.4.1)\n P purrr 1.0.2 2023-08-10 [?] CRAN (R 4.4.0)\n P R6 2.5.1 2021-08-19 [?] RSPM\n P Rcpp 1.0.13 2024-07-17 [?] RSPM\n P remotes 2.5.0 2024-03-17 [?] CRAN (R 4.4.1)\n renv 1.0.7 2024-04-11 [1] RSPM (R 4.4.0)\n P rlang 1.1.4 2024-06-04 [?] RSPM\n P rmarkdown 2.27 2024-05-17 [?] RSPM\n P sessioninfo 1.2.2 2021-12-06 [?] CRAN (R 4.4.1)\n P shiny 1.9.1 2024-08-01 [?] RSPM\n P stringi 1.8.4 2024-05-06 [?] RSPM\n P stringr 1.5.1 2023-11-14 [?] RSPM\n P urlchecker 1.0.1 2021-11-30 [?] CRAN (R 4.4.1)\n P usethis * 3.0.0 2024-07-29 [?] RSPM\n P vctrs 0.6.5 2023-12-01 [?] RSPM\n P xfun 0.46 2024-07-18 [?] RSPM\n P xtable 1.8-4 2019-04-21 [?] CRAN (R 4.4.1)\n P yaml 2.3.10 2024-07-26 [?] RSPM\n\n [1] C:/Users/benia/Desktop/cran-cookbook/cran-cookbook/website/renv/library/windows/R-4.4/x86_64-w64-mingw32\n [2] C:/Users/benia/AppData/Local/R/cache/R/renv/sandbox/windows/R-4.4/x86_64-w64-mingw32/e0da0d43\n\n P ── Loaded and on-disk path mismatch.\n\n──────────────────────────────────────────────────────────────────────────────", + "text": "Technical details\nThis cookbook is a Quarto website. To learn more about Quarto websites visit https://quarto.org/docs/websites. The cookbook is hosted on GitHub pages as part of the Community R development resources. The website is currently deployed with local commands.\n\nSession info\n\nif (!requireNamespace(\"devtools\", quietly = TRUE)) {\n install.packages(\"devtools\")\n}\nlibrary(devtools)\n\nLoading required package: usethis\n\ndevtools::session_info()\n\n─ Session info ───────────────────────────────────────────────────────────────\n setting value\n version R version 4.4.0 (2024-04-24)\n os macOS Ventura 13.6.9\n system x86_64, darwin20\n ui X11\n language (EN)\n collate en_US.UTF-8\n ctype en_US.UTF-8\n tz America/New_York\n date 2024-09-26\n pandoc NA (via rmarkdown)\n\n─ Packages ───────────────────────────────────────────────────────────────────\n ! package * version date (UTC) lib source\n P cachem 1.1.0 2024-05-16 [?] RSPM\n P cli 3.6.3 2024-06-21 [?] RSPM\n P devtools * 2.4.5 2022-10-11 [?] RSPM\n P digest 0.6.36 2024-06-23 [?] RSPM\n P ellipsis 0.3.2 2021-04-29 [?] RSPM\n P evaluate 0.24.0 2024-06-10 [?] RSPM\n P fastmap 1.2.0 2024-05-15 [?] RSPM\n P fs 1.6.4 2024-04-25 [?] RSPM\n P glue 1.7.0 2024-01-09 [?] RSPM\n P htmltools 0.5.8.1 2024-04-04 [?] RSPM\n P htmlwidgets 1.6.4 2023-12-06 [?] RSPM\n P httpuv 1.6.15 2024-03-26 [?] RSPM\n P jsonlite 1.8.8 2023-12-04 [?] RSPM\n P knitr 1.48 2024-07-07 [?] RSPM\n P later 1.3.2 2023-12-06 [?] RSPM\n P lifecycle 1.0.4 2023-11-07 [?] RSPM\n P magrittr 2.0.3 2022-03-30 [?] RSPM\n P memoise 2.0.1 2021-11-26 [?] RSPM\n P mime 0.12 2021-09-28 [?] RSPM\n P miniUI 0.1.1.1 2018-05-18 [?] RSPM\n P pkgbuild 1.4.4 2024-03-17 [?] RSPM\n P pkgload 1.4.0 2024-06-28 [?] RSPM\n P profvis 0.3.8 2023-05-02 [?] RSPM\n P promises 1.3.0 2024-04-05 [?] RSPM\n P purrr 1.0.2 2023-08-10 [?] RSPM\n P R6 2.5.1 2021-08-19 [?] RSPM\n P Rcpp 1.0.13 2024-07-17 [?] RSPM\n P remotes 2.5.0 2024-03-17 [?] RSPM\n renv 1.0.7 2024-04-11 [1] RSPM (R 4.4.0)\n P rlang 1.1.4 2024-06-04 [?] RSPM\n P rmarkdown 2.27 2024-05-17 [?] RSPM\n P rstudioapi 0.16.0 2024-03-24 [?] RSPM\n P sessioninfo 1.2.2 2021-12-06 [?] RSPM\n P shiny 1.9.1 2024-08-01 [?] RSPM\n P stringi 1.8.4 2024-05-06 [?] RSPM\n P stringr 1.5.1 2023-11-14 [?] RSPM\n P urlchecker 1.0.1 2021-11-30 [?] RSPM\n P usethis * 3.0.0 2024-07-29 [?] RSPM\n P vctrs 0.6.5 2023-12-01 [?] RSPM\n P xfun 0.46 2024-07-18 [?] RSPM\n P xtable 1.8-4 2019-04-21 [?] RSPM\n P yaml 2.3.8 2023-12-11 [?] RSPM\n\n [1] /Users/jasminedaly/Desktop/R-directory/cran-cookbook/website/renv/library/macos/R-4.4/x86_64-apple-darwin20\n [2] /Users/jasminedaly/Library/Caches/org.R-project.R/R/renv/sandbox/macos/R-4.4/x86_64-apple-darwin20/2edc1867\n\n P ── Loaded and on-disk path mismatch.\n\n──────────────────────────────────────────────────────────────────────────────", "crumbs": [ "About" ] @@ -359,6 +379,26 @@ "DESCRIPTION file Issues" ] }, + { + "objectID": "description_issues.html#problem-5", + "href": "description_issues.html#problem-5", + "title": "DESCRIPTION file Issues", + "section": "Problem", + "text": "Problem\nThe reference link in the Description field is incorrectly formatted or isn’t clickable.", + "crumbs": [ + "DESCRIPTION file Issues" + ] + }, + { + "objectID": "description_issues.html#solution-5", + "href": "description_issues.html#solution-5", + "title": "DESCRIPTION file Issues", + "section": "Solution", + "text": "Solution\nRemove the space after <doi:…> or <https:…> to enable the reference link. Write the reference in the form: Authors (year) <doi:…>.\n\nDetails\nIdeally, 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 ‘Rcpp’ package:\nDescription: The 'Rcpp' package provides R functions as well as C++ classes which\n offer a seamless integration of R and C++. Many R data types and objects can be\n mapped back and forth to C++ equivalents which facilitates both writing of new\n code as well as easier integration of third-party libraries. Documentation\n about 'Rcpp' is provided by several vignettes included in this package, via the\n 'Rcpp Gallery' site at <https://gallery.rcpp.org>, the paper by Eddelbuettel and\n Francois (2011, <doi:10.18637/jss.v040.i08>), the book by Eddelbuettel (2013,\n <doi:10.1007/978-1-4614-6868-4>) and the paper by Eddelbuettel and Balamuta (2018,\n <doi:10.1080/00031305.2017.1375990>); see 'citation(\"Rcpp\")' for details.\n\n\n\n\n\n\nTip\n\n\n\nIncluding a reference in the Description field is optional, and your package will not be archived if one is missing. You can also use the cran-comments.md file to provide additional references or information.", + "crumbs": [ + "DESCRIPTION file Issues" + ] + }, { "objectID": "general_issues.html#description-length", "href": "general_issues.html#description-length", diff --git a/sitemap.xml b/sitemap.xml index 9f17008..138cf70 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -10,7 +10,7 @@ https://r-devel.github.io/cran-cookbook/code_issues.html - 2024-10-03T19:44:23.285Z + 2024-10-11T09:20:36.333Z https://r-devel.github.io/cran-cookbook/about.html @@ -18,10 +18,10 @@ https://r-devel.github.io/cran-cookbook/description_issues.html - 2024-09-29T13:25:27.438Z + 2024-10-11T09:20:40.033Z https://r-devel.github.io/cran-cookbook/general_issues.html - 2024-09-29T13:25:27.452Z + 2024-10-11T09:20:40.035Z