Skip to content

Commit f61c2d1

Browse files
maelleyabellini
andauthored
add minimal mention of example datasets (#939)
* add minimal mention of example datasets * es translation * Update pkg_building.es.Rmd Co-authored-by: Yanina Bellini Saibene <[email protected]> * Update pkg_building.es.Rmd Co-authored-by: Yanina Bellini Saibene <[email protected]> * Update pkg_building.es.Rmd * Update pkg_building.Rmd --------- Co-authored-by: Yanina Bellini Saibene <[email protected]>
1 parent f9abdb4 commit f61c2d1

File tree

3 files changed

+15
-0
lines changed

3 files changed

+15
-0
lines changed

booknews.Rmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## dev version
44

5+
- 2025-07-11, add minimal mention of example datasets (#868).
6+
57
- 2025-07-17, add category for rOpenSci internal and peer-review tools (#848).
68

79
- 2025-07-09, add more details on how to safeguard docs building for rOpenSci packages (#910, `@rmgpanw`)

pkg_building.Rmd

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,12 @@ f <- function(a = TRUE) {
259259

260260
- 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).
261261

262+
### Example datasets {#example-datasets}
263+
264+
To document your package's interface, you might need to use example datasets.
265+
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.
266+
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.
267+
262268
### URLs in documentation {#ur-ls-in-documentation}
263269

264270
This subsection is particularly relevant to authors wishing to submit their package to CRAN.

pkg_building.es.Rmd

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,13 @@ f <- function(a = TRUE) {
287287

288288
- 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).
289289

290+
### Datos de ejemplo {#example-datasets}
291+
292+
Para documentar la interfaz de tu paquete, es posible que necesites utilizar datos de ejemplo.
293+
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.
294+
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.
295+
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.
296+
290297
### URLs en la documentación {#ur-ls-in-documentation}
291298

292299
Esta subsección es especialmente relevante para quienes deseen enviar su paquete a CRAN.

0 commit comments

Comments
 (0)