Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions booknews.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## dev version

- 2025-07-11, add minimal mention of example datasets (#868).

- 2025-07-17, add category for rOpenSci internal and peer-review tools (#848).

- 2025-07-09, add more details on how to safeguard docs building for rOpenSci packages (#910, `@rmgpanw`)
Expand Down
6 changes: 6 additions & 0 deletions pkg_building.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,12 @@ f <- function(a = TRUE) {

- 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.

### URLs in documentation {#ur-ls-in-documentation}

This subsection is particularly relevant to authors wishing to submit their package to CRAN.
Expand Down
7 changes: 7 additions & 0 deletions pkg_building.es.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,13 @@ f <- function(a = TRUE) {

- 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.

### URLs en la documentación {#ur-ls-in-documentation}

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