Skip to content
Open
Show file tree
Hide file tree
Changes from 9 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
8 changes: 7 additions & 1 deletion booknews.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@

## Dev version

- 2026-05-22, document current AI policies.
- 2026-06-30, document current AI policies.
- 2026-05-21, better document reviewer search in Airtable (#1009, #1010).
- 2026-06-12, add mention of testit (#1014).
- 2026-05-29, link in reviewer guide to stats template for stats reviews (#1012)
- 2026-05-21, clarify that stats must start with a pre-sub (#1011).
- 2026-05-21, add comment on updating Airtable rev-prod for new editors (#1005).
- 2026-05-21, update docs to require pkg websites at submission (#1004).
- 2026-04-10, two fixes to roxygen2 tags mentions (#1000, #1001, `@Pakillo`). Now 4 digits for PRs and issues!

## 1.0.0
Expand Down
Binary file added images/airtable-filters.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/airtable.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 4 additions & 3 deletions pkg_building.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ The badge will first indicated "under review" and then "peer-reviewed" once your
- Consider using `usethis::use_readme_rmd()` to get a template for a `README.Rmd` file and to automatically set up a pre-commit hook to ensure that `README.md` is always newer than `README.Rmd`.

- Extensive examples should be kept for a vignette.
If you want to make the vignettes more accessible before installing the package, we suggest [creating a website for your package](#website).
If you want to make the vignettes more accessible before installing the package, we suggest [creating a website for your package](#website). All packages submitted for software review must have a website.

- Add a [code of conduct and contribution guidelines](#friendlyfiles).

Expand Down Expand Up @@ -305,7 +305,8 @@ Furthermore, links would not be clickable from local docs.

## Documentation website {#website}

We recommend creating a documentation website for your package using [`pkgdown`](https://github.com/r-lib/pkgdown).
All packages submitted for software review must have a documentation website clearly linked in the source repository.
We recommend using [`pkgdown`](https://github.com/r-lib/pkgdown) to create your website.
The R packages book features a [chapter on pkgdown](https://r-pkgs.org/website.html), and of course `pkgdown` has [its own documentation website](https://pkgdown.r-lib.org/).

There are a few elements we'd like to underline here.
Expand Down Expand Up @@ -412,7 +413,7 @@ For how to update your DESCRIPTION file, see the [R packages book](https://r-pkg
- It is good practice to write unit tests for all functions, and all package code in general, ensuring key functionality is covered.
Test coverage below 75% will likely require additional tests or explanation before being sent for review.

- We recommend using [testthat](https://testthat.r-lib.org/) for writing tests. An alternative is [tinytest](https://journal.r-project.org/archive/2021/RJ-2021-056/index.html).
- We recommend using [testthat](https://testthat.r-lib.org/) for writing tests. Alternatives includes [tinytest](https://journal.r-project.org/archive/2021/RJ-2021-056/index.html) or [testit](https://yihui.org/en/2026/05/testthat-to-testit/).

- Strive to write tests as you write each new function.
This serves the obvious need to have proper testing for the package, but allows you to think about various ways in which a function can fail, and to *defensively* code against those.
Expand Down
7 changes: 3 additions & 4 deletions pkg_building.es.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
aliases:
- building.html
---

# Gu铆a de empaquetado {#building}

```{block, type="summaryblock"}
Expand Down Expand Up @@ -207,7 +206,7 @@ La etiqueta indicar谩 primero "en revisi贸n" y luego "revisado" una vez que tu p
- Considera utilizar `usethis::use_readme_rmd()` para generar una plantilla para el archivo `README.Rmd` y para configurar autom谩ticamente un chequeo que garantice que `README.md` sea siempre m谩s reciente que `README.Rmd` antes de hacer un commit.

- Los ejemplos largos deben incluirse s贸lo en las vi帽etas.
Si quieres que las vi帽etas sean m谩s accesibles antes de instalar el paquete, te sugerimos [crear un sitio web para tu paquete](#website).
Si quieres que las vi帽etas sean m谩s accesibles antes de instalar el paquete, te sugerimos [crear un sitio web para tu paquete](#website). Todos los paquetes presentados para su revisi贸n deben contar con un sitio web.

- A帽ade un [c贸digo de conducta y una gu铆a de contribuci贸n](#friendlyfiles).

Expand Down Expand Up @@ -305,6 +304,7 @@ Adem谩s, no se podr谩 hacer click en los enlaces desde la documentaci贸n local.

## Sitio web de documentaci贸n {#website}

Todos los paquetes enviados para su revisi贸n de software deben incluir un enlace claro a la p谩gina web de documentaci贸n en el repositorio de c贸digo fuente.
Comment thread
yabellini marked this conversation as resolved.
Outdated
Te recomendamos que crees un sitio web con la documentaci贸n de tu paquete utilizando [`pkgdown`](https://github.com/r-lib/pkgdown).
Hay un [cap铆tulo sobre pkgdown (en ingl茅s)](https://r-pkgs.org/website.html) en libro "R packages", y, c贸mo no es de extra帽ar, el paquete `pkgdown` tiene [su propio sitio web de documentaci贸n](https://pkgdown.r-lib.org/).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we can link to this resource in Spanish? https://intro-programacion.netlify.app/10_documentacion


Expand Down Expand Up @@ -412,8 +412,7 @@ Para saber c贸mo actualizar tu archivo DESCRIPTION, consulta el libro [*R packag
- Es una buena pr谩ctica escribir *tests* unitarios para todas las funciones, y para todo el c贸digo del paquete en general, asegurando que se cubra las funcionalidades clave.
Si la cobertura de los *tests* en tu paquete est谩 por debajo del 75% probablemente requerir谩 *tests* adicionales o una explicaci贸n de la baja cobertura antes de ser enviado para su revisi贸n.

- Recomendamos utilizar [testthat](https://testthat.r-lib.org/) para escribir los *tests*. Otro paquete que se puede usar es [tinytest](https://journal.r-project.org/archive/2021/RJ-2021-056/index.html).

- Recomendamos utilizar [testthat](https://testthat.r-lib.org/) para escribir los *tests*. Otros paquetes que se pueden usar son [tinytest](https://journal.r-project.org/archive/2021/RJ-2021-056/index.html) y [testit](https://yihui.org/en/2026/05/testthat-to-testit/).
- Intenta escribir *tests* a medida que escribas cada nueva funci贸n.
Esto responde a la necesidad obvia de tener *tests* adecuados para el paquete, pero te permite pensar en varias formas en las que una funci贸n puede fallar, y programar *defensivamente* contra esas fallas.
[M谩s informaci贸n sobre *tests*](https://r-pkgs.org/tests.html).
Expand Down
9 changes: 3 additions & 6 deletions pkg_building.pt.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
aliases:
- building.html
---

# Guia de desenvolvimento de pacotes {#building}

```{block, type="summaryblock"}
Expand Down Expand Up @@ -191,7 +190,7 @@ onde issue\_id 茅 o n煤mero da *Issue* no reposit贸rio `software-review`. Por ex

- Considere o uso da fun莽茫o `usethis::use_readme_rmd()` para obter um modelo para o arquivo `README.Rmd` e para configurar automaticamente uma verifica莽茫o para garantir que o arquivo `README.md` seja sempre mais recente que o `README.Rmd` antes de fazer um commit.

- Exemplos extensos devem ser mantidos em uma vinheta. Se voc锚 quiser tornar as vinhetas mais acess铆veis antes de instalar o pacote, sugerimos [criar um site para seu pacote](#website).
- Exemplos extensos devem ser mantidos em uma vinheta. Se voc锚 quiser tornar as vinhetas mais acess铆veis antes de instalar o pacote, sugerimos [criar um site para seu pacote](#website). Todos os pacotes enviados para a revis茫o de software devem ter um site.

- Adicionar um [c贸digo de conduta e as diretrizes de contribui莽茫o](#friendlyfiles).

Expand Down Expand Up @@ -270,6 +269,7 @@ Outras pessoas j谩 usaram a op莽茫o para escapar de alguns URLs (alterar `<https

## Site de documenta莽茫o {#website}

Todos os pacotes enviados para a revis茫o de software devem ter um site de documenta莽茫o claramente indicado no reposit贸rio de c贸digo-fonte.
Recomendamos a cria莽茫o de um site de documenta莽茫o para seu pacote usando o pacote [`pkgdown`](https://github.com/r-lib/pkgdown). O livro *R packages* (em ingl锚s) apresenta um [cap铆tulo sobre pkgdown](https://r-pkgs.org/website.html) e tamb茅m o `pkgdown` tem [seu pr贸prio site de documenta莽茫o](https://pkgdown.r-lib.org/).

H谩 alguns elementos que gostar铆amos de destacar aqui.
Expand Down Expand Up @@ -360,8 +360,7 @@ Para saber como atualizar seu arquivo DESCRIPTION, consulte [o livro *R packages

- 脡 uma boa pr谩tica escrever testes unit谩rios para todas as fun莽玫es e para todo o c贸digo do pacote em geral, garantindo que a funcionalidade principal seja coberta. Se a cobertura de testes em seu pacote est谩 abaixo de 75%, provavelmente exigir谩 testes adicionais ou explica莽玫es antes de ser enviado para revis茫o.

- Recomendamos o uso do [pacote testthat](https://testthat.r-lib.org/) para escrever testes. Uma alternativa 茅 o [tinytest](https://journal.r-project.org/archive/2021/RJ-2021-056/index.html).

- Recomendamos o uso do [pacote testthat](https://testthat.r-lib.org/) para escrever testes. Outras op莽玫es incluem os pacotes [tinytest](https://journal.r-project.org/archive/2021/RJ-2021-056/index.html) ou [testit](https://yihui.org/en/2026/05/testthat-to-testit/).
- Se esforce para escrever testes ao escrever cada nova fun莽茫o. Isso atende 脿 necessidade 贸bvia de ter um teste adequado para o pacote, mas permite que voc锚 pense sobre as v谩rias maneiras pelas quais uma fun莽茫o pode falhar e programe *defensivamente* contra essas falhas. [Mais informa莽玫es sobre testes](https://r-pkgs.org/tests.html).

- Os testes devem ser f谩ceis de entender e ser t茫o autocontidos quanto poss铆vel. Ao usar o testthat, evite usar c贸digo fora do `test_that()` (como etapas de pr茅-processamento). Recomendamos a leitura da se莽茫o [*"high-level principles for testing"* (princ铆pios de alto n铆vel para testes)](https://r-pkgs.org/testing-design.html#sec-testing-design-principles) no *livro R Packages*.
Expand Down Expand Up @@ -561,5 +560,3 @@ Se voc锚 pretende que seu pacote seja enviado para o Bioconductor ou se o pacote
#### MOOCs {#moo-cs}

Existe um [especializa莽茫o do Coursera correspondente ao livro escrito por Roger Peng, Sean Kross e Brooke Anderson](https://fr.coursera.org/specializations/r), com um curso espec铆fico sobre pacotes R.


4 changes: 2 additions & 2 deletions scripts/airtable-get-data.R
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ at_guest <- airtabler::airtable(base = "app8dssb6a7PG6Vwj",
table = "guest-editors")


editor_index_all <- purrr::map_lgl(reviewers$editor, ~!is.null(.))
editor_index_all <- purrr::map_lgl(reviewers$editor, ~!is.null(.) && !anyNA(.))
editors_all <- reviewers[which(editor_index_all), c("name", "github", "Affiliation", "editor")]
editors_all <- editors_all [which(!editors_all$name == eic_name), ]
last_names <- humaniformat::last_name(trimws(editors_all$name))
editors_all <- editors_all[order(last_names), ]

editors_past <- editors_all[grep("Emeritus", editors_all$editor), ]
editors_past <- editors_all[grep("Emeritus|On\\sLeave", editors_all$editor), ]
editors <- editors_all[which(!editors_all$name %in% editors_past$name), ]

guest_editors <- at_guest$`guest-editors`$select_all()
Expand Down
8 changes: 6 additions & 2 deletions softwarereview_author.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ This concise guide presents the software peer review process for you as a packag
- Consult our [policies](#policies) see if your package meets our criteria for fitting into our suite and does not overlap with other packages.
- If you are unsure whether a package meets our criteria, feel free to open an issue as a pre-submission inquiry to ask if the package is appropriate.
- [Example response regarding overlap](https://github.com/ropensci/software-review/issues/199#issuecomment-375358362). Also consider adding some points about similar packages to your [package documentation](#docs-general).
- Statistical software must comply with additional requirements detailed in our separate [*Statistical Software Guide*](https://stats-devguide.ropensci.org/).
- Statistical software *must* also start with a pre-submission inquiry.

### Lifecycle

Expand All @@ -39,8 +41,10 @@ This concise guide presents the software peer review process for you as a packag

The use of generative AI tools is acceptable in packages submitted for peer review, as described in [our initial blog post](https://ropensci.org/blog/2026/02/26/ropensci-ai-policy/).
As stated in [our general policies](#policies-ai), we require all submitting authors to describe how such tools may have been used, and to include links to any relevant aspects of repositories.
A very general rule-of-thumb is the greater the use of generative AI tools in an rOpenSci submission, the more documentation we will expect, and the more we will expect such tools to have been used _systematically_.
Systematic tool usage includes any approach which transparently and progressively details the contribution of generative AI tools to software production.

- Please provide easy-to-find details or links on any usage of generative AI tools in your documentation, like in [this package](https://apaf-bioinformatics.github.io/HydraR/#robot-use-of-generative-ai).
Comment thread
mpadge marked this conversation as resolved.
Outdated
- A very general rule-of-thumb is the greater the use of generative AI tools in an rOpenSci submission, the more documentation we will expect, and the more we will expect such tools to have been used _systematically_.
Comment thread
mpadge marked this conversation as resolved.
Outdated
- Systematic tool usage includes any approach which transparently and progressively details the contribution of generative AI tools to software production, such as [GitHub's "spec-kit"](https://github.github.com/spec-kit/).
Examples of systematic generative AI tools range from [GitHub's "spec-kit" for specification-driven development](https://github.com/github/spec-kit) to [our own experimental tool to document software design decisions](https://github.com/ropensci-review-tools/designlens).
These all share the common pattern of producing additional artefacts which document the _process_ of development alongside the software itself.

Expand Down
3 changes: 3 additions & 0 deletions softwarereview_author.es.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ Esta gu铆a condensa el proceso de revisi贸n por pares desde el punto de vista de
- Si no sabes si un paquete cumple con nuestros criterios, no dudes en abrir un _issue_ para consultarlo.
- [Ejemplo de respuesta sobre solapamiento](https://github.com/ropensci/software-review/issues/199#issuecomment-375358362). Considera tambi茅n a帽adir informaci贸n sobre paquetes similares a tu [documentaci贸n de paquetes](#docs-general).

- Los paquetes estad铆sticos deben cumplir los requisitos adicionales que se detallan en nuestra otra [*Gu铆a de desarrollo de software estad铆stico*](https://stats-devguide.ropensci.org/).
- Software estad铆stico *debe* comenzar tambi茅n con una investigaci贸n previa a la presentaci贸n.
Comment thread
yabellini marked this conversation as resolved.
Outdated

### Ciclo de desarrollo

- Por favor, no envies varios paquetes a la vez: te rogamos que espere hasta que un paquete haya sido aprobado antes de enviar otro.
Expand Down
5 changes: 4 additions & 1 deletion softwarereview_author.pt.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,12 @@ Este guia conciso apresenta o processo de revis茫o de software por pares, para v
### Escopo

- Consulte nossas [pol铆ticas de uso](#policies) para ver se o seu pacote atende aos nossos crit茅rios e se encaixa em nossa cole莽茫o, n茫o se sobrepondo a outros pacotes j谩 existentes.
- Se voc锚 n茫o tiver certeza de que um pacote atende aos nossos crit茅rios, sinta-se 脿 vontade para abrir um _issue_ no GitHub como uma consulta de pr茅-submiss茫o para perguntar se o pacote 茅 apropriado.
- Caso n茫o tenha certeza se um pacote atende aos nossos crit茅rios, sinta-se 脿 vontade para abrir uma _issue_ no GitHub como uma consulta de pr茅-submiss茫o para perguntar se o pacote 茅 apropriado.
- [Exemplo de resposta a sobreposi莽茫o](https://github.com/ropensci/software-review/issues/199#issuecomment-375358362). Tamb茅m considere adicionar alguns pontos sobre pacotes semelhantes ao seu na sua [documenta莽茫o do pacote](#docs-general).

- O software estat铆stico deve atender aos requisitos adicionais detalhados em nosso [*Guia de software estat铆stico*](https://stats-devguide.ropensci.org/).
- O software estat铆stico tamb茅m *deve* come莽ar com uma consulta pr茅-submiss茫o.

### Ciclo de vida

- N茫o envie v谩rios pacotes ao mesmo tempo: solicitamos que voc锚 espere at茅 que um pacote seja aprovado antes de enviar outro.
Expand Down
13 changes: 9 additions & 4 deletions softwarereview_editor.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -271,11 +271,16 @@ When these sources of information are not enough,

##### Tips for reviewer search in Airtable {#tips-for-reviewer-search-in-airtable}

You can use filters, sorting, and search to identify reviewers with particular experience:
Our Airtable database is linked at the top of our Slack 'editors-only' channel.
Once you log in to Airtable via that link, you should see "*rOpenSci Software Review Database*" with "*Search Reviewers*" at the top left:

![Screenshot of the Airtable filters interface with a filter on domain expertise that has to include chemistry and technical areas that have to include continuous integration](images/airtable.png)
![Screenshot of the main Airtable interface with 'Search Reviewers' link](images/airtable.png)

Please check the reviewer's most recent review and avoid anyone who has reviewed anyone in the past six months.
At the top right, there is a "Filter" button to filter, sort, and search reviewers with particular experience:

![Screenshot of the Airtable filters interface with a filter on domain expertise that has to include chemistry and technical areas that have to include continuous integration](images/airtable-filters.png)

Please check potential reviewers' most recent review and avoid anyone who has reviewed anyone in the past six months.
Also, please check if a first-time reviewer has indicated that they `require_mentorship`.
If so, please use the mentorship portion of the email template and be prepared to provide additional guidance.

Expand Down Expand Up @@ -364,4 +369,4 @@ For package authors who wish to retain their repositories in their original GitH

#### Package promotion {#package-promotion}

- Direct the author to the chapters of the guide about [package releases](#releases), [marketing](#marketing) and [GitHub grooming](#grooming).
- Direct the author to the chapters of the guide about [package releases](#releases), [marketing](#marketing) and [GitHub grooming](#grooming).
7 changes: 4 additions & 3 deletions softwarereview_editor.es.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -271,9 +271,10 @@ Cuando estas fuentes de informaci贸n no sean suficientes,

##### Consejos para la b煤squeda en Airtable {#tips-for-reviewer-search-in-airtable}

Puedes utilizar filtros, clasificaci贸n y b煤squeda para identificar personas para la revisi贸n con una experiencia concreta:
Nuestra base de datos de Airtable aparece enlazada en la parte superior de nuestro canal de Slack 芦*editors-only (solo equipo editorial)禄.
Comment thread
yabellini marked this conversation as resolved.
Outdated
Una vez que inicies sesi贸n en Airtable a trav茅s de ese enlace, deber铆as ver 芦*rOpenSci Software Review Database (Base de datos de rese帽as de software de rOpenSci)*禄 con la opci贸n 芦*Search Reviewers (buscar revisores)*禄 en la parte superior izquierda:
Comment thread
yabellini marked this conversation as resolved.
Outdated

![Captura de pantalla de la interfaz de filtros de Airtable con un filtro sobre experiencia en disciplinas que debe incluir qu铆mica y en conocimientos t茅cnicos que tienen que incluir integraci贸n continua](images/airtable.png)
![Captura de pantalla de la interfaz de filtros de Airtable con un filtro sobre experiencia en disciplinas que debe incluir qu铆mica y en conocimientos t茅cnicos que tienen que incluir integraci贸n continua](images/airtable-filters.png)
Comment thread
yabellini marked this conversation as resolved.
Outdated

Comprueba la revisi贸n m谩s reciente de la persona y evita a cualquiera que haya revisado en los 煤ltimos seis meses.
Asimismo, comprueba si una persona que es nueva revisando ha indicado que requiere tutor铆a en el campo`require_mentorship`.
Expand Down Expand Up @@ -364,4 +365,4 @@ Para aquellas personas que deseen mantener los repositorios de su paquete en sus

#### Promoci贸n de paquetes {#package-promotion}

- Dirige a qui茅n envi贸 el paquete a los cap铆tulos de la gu铆a sobre [versionado y publicaci贸n de paquetes](#releases), [marketing](#marketing) y [preparaci贸n para GitHub](#grooming).
- Dirige a qui茅n envi贸 el paquete a los cap铆tulos de la gu铆a sobre [versionado y publicaci贸n de paquetes](#releases), [promocionando tu paquete](#marketing) y [gesti贸n de GitHub](#grooming).
Loading