Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 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-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)
Expand Down
6 changes: 6 additions & 0 deletions pkg_building.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 6 additions & 0 deletions pkg_building.es.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading