Skip to content

Commit 7d78055

Browse files
maellemaelle
committed
conflicts
Merge branch 'master' into dev # Conflicts: # softwarereview_intro.Rmd # templates/review-es.md # templates/review.md
2 parents b9820d9 + ea1b4a1 commit 7d78055

File tree

7 files changed

+89
-8
lines changed

7 files changed

+89
-8
lines changed

‎.github/workflows/dev.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jobs:
2525
- uses: r-lib/actions/setup-tinytex@v1
2626

2727
- name: Cache R packages
28-
uses: actions/cache@v1
28+
uses: actions/cache@v2
2929
with:
3030
path: ${{ env.R_LIBS_USER }}
3131
key: ${{ hashFiles('DESCRIPTION') }}

‎.github/workflows/master.yml‎

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,24 @@ jobs:
1717
- uses: r-lib/actions/setup-pandoc@v1
1818
- uses: r-lib/actions/setup-tinytex@v1
1919
- name: Cache R packages
20-
uses: actions/cache@v1
20+
uses: actions/cache@v2
2121
with:
2222
path: ${{ env.R_LIBS_USER }}
2323
key: ${{ hashFiles('DESCRIPTION') }}
24-
- name: Install dependencies
25-
run: Rscript -e 'install.packages("remotes")' -e 'remotes::install_deps(dependencies = TRUE)'
24+
- name: Install pak and query dependencies
25+
run: |
26+
install.packages("pak", repos = "https://r-lib.github.io/p/pak/dev/")
27+
saveRDS(pak::pkg_deps("local::.", dependencies = TRUE), ".github/r-depends.rds")
28+
shell: Rscript {0}
29+
30+
- name: Restore R package cache
31+
uses: actions/cache@v2
32+
with:
33+
path: |
34+
${{ env.R_LIBS_USER }}/*
35+
!${{ env.R_LIBS_USER }}/pak
36+
key: macOS-${{ steps.install-r.outputs.installed-r-version }}-1-${{ hashFiles('.github/r-depends.rds') }}
37+
restore-keys: macOS-${{ steps.install-r.outputs.installed-r-version }}-1-
2638
- name: Render book html
2739
run: Rscript -e 'bookdown::render_book("index.Rmd", "bookdown::bs4_book", params = list(AIRTABLE_API_KEY = ${{ secrets.AIRTABLE_API_KEY }}))'
2840
env: # Set the secret as an input
@@ -41,8 +53,6 @@ jobs:
4153
git config --global user.email "[email protected]"
4254
git config --global user.name "gh-pages committer"
4355
- name: Commit results
44-
env: # Set the secret as an input
45-
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
4656
run: |
4757
cp ghpagescname _book/CNAME
4858
cd _book

‎.github/workflows/pr.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jobs:
2525
- uses: r-lib/actions/setup-tinytex@v1
2626

2727
- name: Cache R packages
28-
uses: actions/cache@v1
28+
uses: actions/cache@v2
2929
with:
3030
path: ${{ env.R_LIBS_USER }}
3131
key: ${{ hashFiles('DESCRIPTION') }}

‎index.Rmd‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "rOpenSci Packages: Development, Maintenance, and Peer Review"
3-
author: "rOpenSci software review editorial team (current and alumni): Brooke Anderson, Scott Chamberlain, Laura DeCicco, Julia Gustavsen, Anna Krystalli, Mauro Lepore, Lincoln Mullen, Karthik Ram, Noam Ross, Maëlle Salmon, Melina Vidoni"
3+
author: "rOpenSci software review editorial team (current and alumni): Brooke Anderson, Scott Chamberlain, Laura DeCicco, Julia Gustavsen, Jeff Hollister, Anna Krystalli, Mauro Lepore, Lincoln Mullen, Karthik Ram, Emily Riederer, Noam Ross, Maëlle Salmon, Adam Sparks, Melina Vidoni"
44
date: "`r Sys.Date()`"
55
site: bookdown::bookdown_site
66
documentclass: book

‎softwarereview_intro.Rmd‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ rOpenSci's Software Peer Review process is run by:
6666
* [Laura DeCicco](https://github.com/ldecicco-USGS), USGS
6767
* [Julia Gustavsen](https://github.com/jooolia), Agroscope
6868
* [Emily Riederer](https://github.com/emilyriederer), Capital One
69+
* [Adam Sparks](https://github.com/adamhsparks), Department of Primary Industries and Regional Development
70+
* [Jeff Hollister](https://github.com/jhollist), US Environmental Protection Agency
6971

7072
### Reviewers
7173

@@ -85,6 +87,7 @@ if (Sys.getenv("AIRTABLE_API_KEY") != ""){
8587
}
8688
}
8789
```
90+
8891
```{r reviewers, echo=FALSE, results='asis', eval=has_airtable_access}
8992
editors <- c(
9093
"Noam Ross", "Karthik Ram", "Maëlle Salmon",

‎templates/review-es.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## Revisión de un paquete
2+
3+
*Por favor trata de marcar tantas casillas como te sea posible y elabora tus argumentos en comentarios abajo de cada una. Tu revisión no esta limitada a estos temas, tal como se describe en la guia para revisores (Reviewer Guide)*
4+
5+
**Por favor describe cualquier relación de trabajo que tengas/hayas tenido con los autores del paquete)**
6+
7+
- [ ] Como revisor confirmo que no tengo [conflictos de interés](https://devguide.ropensci.org/policies.html#coi) para poder hacer la revisión de este trabajo (si no estas segura si tienes un conflicto por favor entra en contacto con tu editor _antes_ de arrancar con la revisión.
8+
9+
#### Documentación
10+
11+
El paquete incluye todos los siguiente tipos de documentación:
12+
13+
- [ ] **Una declaración de necesidades** que claramente describe las necesidades que el software esta diseñado a resolver y el public meta que busca atender en el archivo README
14+
- [ ] **Instrucciones de instalación** de la versión en desarrollo del paquete incluyendo cualquier dependencia no-estándar en el archivo README
15+
- [ ] **Viñeta(s)** demostrando la funcionalidad principal que ademas corren localmente
16+
- [ ] **Documentación de las funciones** exportadas
17+
- [ ] **Ejemplos** (que corren localmente) para todas las funciones exportadas
18+
- [ ] **Directrices comunitarias** incluyendo una guia de contribución en el archivo README o el archivo CONTRIBUTING y un archivo DESCRIPTION que incluye `URL`, `BugReports` and `Maintainer` (todas en inglés por concenvión y para que puedan ser autogeneradas con `Authors@R`).
19+
20+
#### Functionality
21+
22+
- [ ] **Instalación:** La instalación se completa con éxito tal como fue documentada.
23+
- [ ] **Funcionalidad:** Toda afirmación de funcionalidad del software se confirma como existente.
24+
- [ ] **Desempeño:** Toda afirmación de desempeño del software se confirma como alcanzada.
25+
- [ ] **Pruebas automáticas:** Hay pruebas unitarias que cubren las funciones esenciales dentro del paquete con un rango razonable de entradas y condiciones. Todas las pruebas corren en la maquina local.
26+
- [ ] **Directrices de empaque**: El paquete cumple con las directrices de empaque de rOpenSci.
27+
28+
Estimación de horas dedicadas a la revisión:
29+
30+
- [ ] Si la o las persona(s) autora(s) lo considera(n) apropiado, yo estoy de acuerdo con que me reconozcan como revisor del paquete (el rol "rev') en la el archivo DESCRIPTION del paquete.
31+
32+
---
33+
34+
### Comentarios de la revisión

‎templates/review.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## Package Review
2+
3+
*Please check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide*
4+
5+
- **Briefly describe any working relationship you have (had) with the package authors.**
6+
- [ ] As the reviewer I confirm that there are no [conflicts of interest](https://devguide.ropensci.org/policies.html#coi) for me to review this work (If you are unsure whether you are in conflict, please speak to your editor _before_ starting your review).
7+
8+
#### Documentation
9+
10+
The package includes all the following forms of documentation:
11+
12+
- [ ] **A statement of need** clearly stating problems the software is designed to solve and its target audience in README
13+
- [ ] **Installation instructions:** for the development version of package and any non-standard dependencies in README
14+
- [ ] **Vignette(s)** demonstrating major functionality that runs successfully locally
15+
- [ ] **Function Documentation:** for all exported functions
16+
- [ ] **Examples** (that run successfully locally) for all exported functions
17+
- [ ] **Community guidelines** including contribution guidelines in the README or CONTRIBUTING, and DESCRIPTION with `URL`, `BugReports` and `Maintainer` (which may be autogenerated via `Authors@R`).
18+
19+
#### Functionality
20+
21+
- [ ] **Installation:** Installation succeeds as documented.
22+
- [ ] **Functionality:** Any functional claims of the software been confirmed.
23+
- [ ] **Performance:** Any performance claims of the software been confirmed.
24+
- [ ] **Automated tests:** Unit tests cover essential functions of the package
25+
and a reasonable range of inputs and conditions. All tests pass on the local machine.
26+
- [ ] **Packaging guidelines**: The package conforms to the rOpenSci packaging guidelines
27+
28+
Estimated hours spent reviewing:
29+
30+
- [ ] Should the author(s) deem it appropriate, I agree to be acknowledged as a package reviewer ("rev" role) in the package DESCRIPTION file.
31+
32+
---
33+
34+
### Review Comments

0 commit comments

Comments
 (0)