From 536d4a7629ca3d18523a2114dce1c9094ded6f01 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Fri, 11 Jul 2025 14:19:33 +0200 Subject: [PATCH 1/6] add minimal mention of example datasets --- booknews.Rmd | 2 ++ pkg_building.Rmd | 6 ++++++ 2 files changed, 8 insertions(+) diff --git a/booknews.Rmd b/booknews.Rmd index ef5190610..f5683019d 100644 --- a/booknews.Rmd +++ b/booknews.Rmd @@ -2,6 +2,8 @@ ## dev version +- 2025-07-11, add minimal mention of example datasets (#868). + - 2025-07-09, add a mention of ROR IDs (#909). - 2025-07-09, remove the upper-case from the NEWS.md template and update the real example link. (#896) diff --git a/pkg_building.Rmd b/pkg_building.Rmd index 6d6487ab2..ba345bb33 100644 --- a/pkg_building.Rmd +++ b/pkg_building.Rmd @@ -256,6 +256,12 @@ f <- function(a = TRUE) { - Starting from roxygen2 version 7.0.0, `R6` classes are officially supported. See the [roxygen2 docs](https://roxygen2.r-lib.org/articles/rd-other.html#r6) for details on how to document `R6` classes. +### Example datasets {#example-datasets} + +To document your package's interface, you might need to use example datasets. +You can either use base R datasets (in the datasets package) such as penguins, or [re-distribute and document data](https://r-pkgs.org/data.html), with proper attributions. +Be careful to choose data that comply with the [rOpenSci's code of conduct](https://ropensci.org/code-of-conduct/) and generally is not hurtful or alienating to anyone. + ### URLs in documentation {#ur-ls-in-documentation} This subsection is particularly relevant to authors wishing to submit their package to CRAN. From 43a9822e15c15740f8d2c89a6246e7f4b84e8102 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Fri, 11 Jul 2025 16:27:20 +0200 Subject: [PATCH 2/6] es translation --- pkg_building.es.Rmd | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/pkg_building.es.Rmd b/pkg_building.es.Rmd index e3bb2b9dc..2ac16484a 100644 --- a/pkg_building.es.Rmd +++ b/pkg_building.es.Rmd @@ -284,6 +284,12 @@ f <- function(a = TRUE) { - A partir de la versión 7.0.0 de roxygen2, las clases `R6` son oficialmente compatibles. Consulta la [documentación de roxygen2](https://roxygen2.r-lib.org/articles/rd-other.html#r6) para saber cómo documentar las clases `R6`. +### Datos de ejemplo {#example-datasets} + +Para documentar la interfaz de su paquete, es posible que necesites utilizar datos de ejemplo. +Puedes utilizar datos de R base (en el paquete datasets), como penguins, o [redistribuir y documentar datos](https://r-pkgs.org/data.html), con las atribuciones adecuadas. +Ten cuidado de elegir datos que cumplan con el [código de conducta de rOpenSci](https://ropensci.org/code-of-conduct/) y que, en general, no sean perjudiciales ni alienantes para nadie. + ### URLs en la documentación {#ur-ls-in-documentation} Esta subsección es especialmente relevante para quienes deseen enviar su paquete a CRAN. From 10b5cc46c7d79b3a0bafecab4acb99c4c0dc13b6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Tue, 19 Aug 2025 15:02:35 +0200 Subject: [PATCH 3/6] Update pkg_building.es.Rmd Co-authored-by: Yanina Bellini Saibene --- pkg_building.es.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkg_building.es.Rmd b/pkg_building.es.Rmd index 2ac16484a..7255a9ad0 100644 --- a/pkg_building.es.Rmd +++ b/pkg_building.es.Rmd @@ -286,7 +286,7 @@ f <- function(a = TRUE) { ### Datos de ejemplo {#example-datasets} -Para documentar la interfaz de su paquete, es posible que necesites utilizar datos de ejemplo. +Para documentar la interfaz de tu paquete, es posible que necesites utilizar datos de ejemplo. Puedes utilizar datos de R base (en el paquete datasets), como penguins, o [redistribuir y documentar datos](https://r-pkgs.org/data.html), con las atribuciones adecuadas. Ten cuidado de elegir datos que cumplan con el [código de conducta de rOpenSci](https://ropensci.org/code-of-conduct/) y que, en general, no sean perjudiciales ni alienantes para nadie. From e135dbd226c72ebb847f0acf901ba8866ef49315 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Tue, 19 Aug 2025 15:02:50 +0200 Subject: [PATCH 4/6] Update pkg_building.es.Rmd Co-authored-by: Yanina Bellini Saibene --- pkg_building.es.Rmd | 1 + 1 file changed, 1 insertion(+) diff --git a/pkg_building.es.Rmd b/pkg_building.es.Rmd index 7255a9ad0..cb4149fa4 100644 --- a/pkg_building.es.Rmd +++ b/pkg_building.es.Rmd @@ -288,6 +288,7 @@ f <- function(a = TRUE) { Para documentar la interfaz de tu paquete, es posible que necesites utilizar datos de ejemplo. Puedes utilizar datos de R base (en el paquete datasets), como penguins, o [redistribuir y documentar datos](https://r-pkgs.org/data.html), con las atribuciones adecuadas. +Si quieres usar conjuntos de datos en español, puedes utilizar el paquete [datos](https://cran.r-project.org/web/packages/datos/readme/README.html) que provee la traducción al español de conjuntos de datos en inglés originalmente disponibles en otros paquetes de R, como pinguinos. Ten cuidado de elegir datos que cumplan con el [código de conducta de rOpenSci](https://ropensci.org/code-of-conduct/) y que, en general, no sean perjudiciales ni alienantes para nadie. ### URLs en la documentación {#ur-ls-in-documentation} From 990632434de81128a2698b35b8378588498fb196 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Tue, 19 Aug 2025 15:04:07 +0200 Subject: [PATCH 5/6] Update pkg_building.es.Rmd --- pkg_building.es.Rmd | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pkg_building.es.Rmd b/pkg_building.es.Rmd index ac14e8cde..8fc077ec1 100644 --- a/pkg_building.es.Rmd +++ b/pkg_building.es.Rmd @@ -285,13 +285,14 @@ f <- function(a = TRUE) { - A partir de la versión 7.0.0 de roxygen2, las clases `R6` son oficialmente compatibles. Consulta la [documentación de roxygen2](https://roxygen2.r-lib.org/articles/rd-other.html#r6) para saber cómo documentar las clases `R6`. +- Todavía no hay soporte para proporcionar páginas web de manual en diferentes idiomas, pero se han producido avances interesantes en el paquete [rhelpi18n](https://github.com/eliocamp/rhelpi18n). + ### Datos de ejemplo {#example-datasets} Para documentar la interfaz de tu paquete, es posible que necesites utilizar datos de ejemplo. Puedes utilizar datos de R base (en el paquete datasets), como penguins, o [redistribuir y documentar datos](https://r-pkgs.org/data.html), con las atribuciones adecuadas. Si quieres usar conjuntos de datos en español, puedes utilizar el paquete [datos](https://cran.r-project.org/web/packages/datos/readme/README.html) que provee la traducción al español de conjuntos de datos en inglés originalmente disponibles en otros paquetes de R, como pinguinos. Ten cuidado de elegir datos que cumplan con el [código de conducta de rOpenSci](https://ropensci.org/code-of-conduct/) y que, en general, no sean perjudiciales ni alienantes para nadie. -- Todavía no hay soporte para proporcionar páginas web de manual en diferentes idiomas, pero se han producido avances interesantes en el paquete [rhelpi18n](https://github.com/eliocamp/rhelpi18n). ### URLs en la documentación {#ur-ls-in-documentation} From f4d79fa12821ed7f6ab9399c7cbc53587432d4aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Tue, 19 Aug 2025 15:04:32 +0200 Subject: [PATCH 6/6] Update pkg_building.Rmd --- pkg_building.Rmd | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pkg_building.Rmd b/pkg_building.Rmd index df1853c3f..af01dab8d 100644 --- a/pkg_building.Rmd +++ b/pkg_building.Rmd @@ -257,12 +257,13 @@ f <- function(a = TRUE) { - Starting from roxygen2 version 7.0.0, `R6` classes are officially supported. See the [roxygen2 docs](https://roxygen2.r-lib.org/articles/rd-other.html#r6) for details on how to document `R6` classes. +- There is no support for providing manual pages in different languages yet, but some interesting progress in the [rhelpi18n R package](https://github.com/eliocamp/rhelpi18n). + ### Example datasets {#example-datasets} To document your package's interface, you might need to use example datasets. You can either use base R datasets (in the datasets package) such as penguins, or [re-distribute and document data](https://r-pkgs.org/data.html), with proper attributions. Be careful to choose data that comply with the [rOpenSci's code of conduct](https://ropensci.org/code-of-conduct/) and generally is not hurtful or alienating to anyone. -- There is no support for providing manual pages in different languages yet, but some interesting progress in the [rhelpi18n R package](https://github.com/eliocamp/rhelpi18n). ### URLs in documentation {#ur-ls-in-documentation}