Skip to content

Commit ae5969a

Browse files
maelleyabellinibeatrizmilz
authored
add how to deprecate data (#894)
* add how to deprecate data * news item * Update maintenance_evolution.es.Rmd Co-authored-by: Yanina Bellini Saibene <[email protected]> * Update maintenance_evolution.es.Rmd * add change to the right place * Update maintenance_evolution.pt.Rmd Co-authored-by: Beatriz Milz <[email protected]> --------- Co-authored-by: Yanina Bellini Saibene <[email protected]> Co-authored-by: Beatriz Milz <[email protected]>
1 parent 860b266 commit ae5969a

File tree

4 files changed

+19
-0
lines changed

4 files changed

+19
-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-03-13, add a note on how to deprecate *data* (#649)
6+
57
- 2025-04-10, add link to pkgcheck vignette on our testing environment (#589)
68

79
- 2025-04-10, replace the link to the Mozilla Code Review guide with explicit items (#835)

maintenance_evolution.Rmd

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,12 @@ After users have used the package version for a while (with both `foo` and `bar`
104104
bar <- function(x) x + 1
105105
```
106106

107+
## Data: deprecate
108+
109+
If you need to deprecate a dataset provided by your package,
110+
read the [solution proposed by Matthijs Berends on Stack Overflow](https://stackoverflow.com/questions/33304651/data-deprecation-in-r-package/75192818#75192818), linking to [a 3-step method in Bioconductor guidance](https://contributions.bioconductor.org/deprecation.html#deprecate-dataset).
111+
Key is the usage of [`delayedAssign()`](https://stat.ethz.ch/R-manual/R-patched/library/base/html/delayedAssign.html) to save a promise that will serve both a warning, and the data.
112+
107113
## Functions: deprecate \& defunct {#functions-deprecate-defunct}
108114

109115
To remove a function from a package (let's say your package name is `helloworld`), you can use the following protocol:

maintenance_evolution.es.Rmd

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,12 @@ No es necesario que cambies los test de las funciones obsoletas hasta que caduqu
207207

208208
Una vez que se caduca una función, sus tests se eliminan sin más.
209209

210+
## Datos: obsoletos
211+
212+
Si necesita eliminar un conjunto de datos proporcionado por tu paquete,
213+
lee la [solución propuesta por Matthijs Berends en Stack Overflow](https://stackoverflow.com/questions/33304651/data-deprecation-in-r-package/75192818#75192818), que enlaza con [un método de 3 pasos en la guía de Bioconductor](https://contributions.bioconductor.org/deprecation.html#deprecate-dataset).
214+
La clave es el uso de [`delayedAssign()`](https://stat.ethz.ch/R-manual/R-patched/library/base/html/delayedAssign.html) para guardar una promesa que servirá tanto de aviso, como para poder disponible los datos.
215+
210216
## Archivando paquetes {#archivalguidance}
211217

212218
Por lo general, el software tiene una vida útil finita, y es posible que los paquetes deban ser archivados en algún momento.

maintenance_evolution.pt.Rmd

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,11 @@ Depois que os usuários tiverem usado a versão do pacote por algum tempo (com a
104104
bar <- function(x) x + 1
105105
```
106106

107+
## Dados: descontinuar
108+
109+
Se você precisar descontinuar (*deprecate*) um conjunto de dados fornecido pelo seu pacote,
110+
leia a [solução proposta por Matthijs Berends no Stack Overflow](https://stackoverflow.com/questions/33304651/data-deprecation-in-r-package/75192818#75192818), com link para [um método de três etapas na orientação do Bioconductor] (https://contributions.bioconductor.org/deprecation.html#deprecate-dataset).
111+
O ponto principal é o uso de [`delayedAssign()`](https://stat.ethz.ch/R-manual/R-patched/library/base/html/delayedAssign.html) para criar uma *promise* que servirá tanto para emitir um aviso (*warning*) quanto para fornecer os dados.
107112
## Funções: descontinuadas e removidas {#functions-deprecate-defunct}
108113

109114
Para remover uma função de um pacote (digamos que o nome do seu pacote seja `helloworld`), você pode usar o seguinte protocolo:

0 commit comments

Comments
 (0)