From 148014a2cb413ab5d28f3e0a152d004319be0e8f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Tue, 11 Mar 2025 15:56:53 +0100 Subject: [PATCH 1/6] add how to deprecate data --- maintenance_evolution.es.Rmd | 6 ++++++ maintenance_evolution.pt.Rmd | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/maintenance_evolution.es.Rmd b/maintenance_evolution.es.Rmd index b5c7e3c10..322db168d 100644 --- a/maintenance_evolution.es.Rmd +++ b/maintenance_evolution.es.Rmd @@ -207,6 +207,12 @@ No es necesario que cambies los test de las funciones obsoletas hasta que caduqu Una vez que se caduca una función, sus tests se eliminan sin más. +## Datos: obsoletos + +Si necesita eliminar un conjunto de datos proporcionado por tu paquete, +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). +La clave es el uso de `delayedAssign()` para guardar una promesa que servirá tanto de aviso, como los datos. + ## Archivando paquetes {#archivalguidance} Por lo general, el software tiene una vida útil finita, y es posible que los paquetes deban ser archivados en algún momento. diff --git a/maintenance_evolution.pt.Rmd b/maintenance_evolution.pt.Rmd index 44dc28230..67ffd1fac 100644 --- a/maintenance_evolution.pt.Rmd +++ b/maintenance_evolution.pt.Rmd @@ -104,6 +104,12 @@ After users have used the package version for a while (with both `foo` and `bar` bar <- function(x) x + 1 ``` +## Data: deprecate + +If you need to deprecate a dataset provided by your package, +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). +Key is the usage of `delayedAssign()` to save a promise that will serve both a warning, and the data. + ## Functions: deprecate \& defunct {#functions-deprecate-defunct} To remove a function from a package (let's say your package name is `helloworld`), you can use the following protocol: From e5c4076e93d357373f801d55fe9f0501bbb14092 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Thu, 13 Mar 2025 13:09:10 +0100 Subject: [PATCH 2/6] news item --- booknews.Rmd | 2 ++ 1 file changed, 2 insertions(+) diff --git a/booknews.Rmd b/booknews.Rmd index 60e74d032..01ecaa0b1 100644 --- a/booknews.Rmd +++ b/booknews.Rmd @@ -2,6 +2,8 @@ ## dev version +- 2025-03-13, add a note on how to deprecate *data* (#649) + - 2025-03-11, mention the Air formatting tool wherever we mention the styler package (#875) - 2025-02-25, require the default git branch to not be called master (#863) From 91ffcfeccf47cf2fbef6a968c85a308ce778e7f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Fri, 28 Mar 2025 14:06:27 +0100 Subject: [PATCH 3/6] Update maintenance_evolution.es.Rmd Co-authored-by: Yanina Bellini Saibene --- maintenance_evolution.es.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/maintenance_evolution.es.Rmd b/maintenance_evolution.es.Rmd index 322db168d..6db34f3f6 100644 --- a/maintenance_evolution.es.Rmd +++ b/maintenance_evolution.es.Rmd @@ -211,7 +211,7 @@ Una vez que se caduca una función, sus tests se eliminan sin más. Si necesita eliminar un conjunto de datos proporcionado por tu paquete, 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). -La clave es el uso de `delayedAssign()` para guardar una promesa que servirá tanto de aviso, como los datos. +La clave es el uso de `delayedAssign()` para guardar una promesa que servirá tanto de aviso, como para poder disponible los datos. ## Archivando paquetes {#archivalguidance} From efe93f96c6cb00c90682754db72098143911f95b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Fri, 28 Mar 2025 14:07:42 +0100 Subject: [PATCH 4/6] Update maintenance_evolution.es.Rmd --- maintenance_evolution.es.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/maintenance_evolution.es.Rmd b/maintenance_evolution.es.Rmd index 6db34f3f6..40ef62a3c 100644 --- a/maintenance_evolution.es.Rmd +++ b/maintenance_evolution.es.Rmd @@ -211,7 +211,7 @@ Una vez que se caduca una función, sus tests se eliminan sin más. Si necesita eliminar un conjunto de datos proporcionado por tu paquete, 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). -La clave es el uso de `delayedAssign()` para guardar una promesa que servirá tanto de aviso, como para poder disponible los datos. +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. ## Archivando paquetes {#archivalguidance} From a813e6d0a7f48f4565ab8377ebc99670ae6de385 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Fri, 28 Mar 2025 14:14:49 +0100 Subject: [PATCH 5/6] add change to the right place --- maintenance_evolution.Rmd | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/maintenance_evolution.Rmd b/maintenance_evolution.Rmd index 93fd77015..09bcc94a8 100644 --- a/maintenance_evolution.Rmd +++ b/maintenance_evolution.Rmd @@ -104,6 +104,12 @@ After users have used the package version for a while (with both `foo` and `bar` bar <- function(x) x + 1 ``` +## Data: deprecate + +If you need to deprecate a dataset provided by your package, +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). +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. + ## Functions: deprecate \& defunct {#functions-deprecate-defunct} To remove a function from a package (let's say your package name is `helloworld`), you can use the following protocol: From 7e44bf690eb79f172574ca10408e1acfc688f3a6 Mon Sep 17 00:00:00 2001 From: Yanina Bellini Saibene Date: Mon, 21 Apr 2025 18:29:57 -0300 Subject: [PATCH 6/6] Update maintenance_evolution.pt.Rmd Co-authored-by: Beatriz Milz <42153618+beatrizmilz@users.noreply.github.com> --- maintenance_evolution.pt.Rmd | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/maintenance_evolution.pt.Rmd b/maintenance_evolution.pt.Rmd index c3fd58b92..a0d0f1b10 100644 --- a/maintenance_evolution.pt.Rmd +++ b/maintenance_evolution.pt.Rmd @@ -104,12 +104,11 @@ Depois que os usuários tiverem usado a versão do pacote por algum tempo (com a bar <- function(x) x + 1 ``` -## Dados: depreciar - -Se você precisar depreciar um conjunto de dados fornecido pelo seu pacote, -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). -O ponto principal é o uso de [`delayedAssign()`](https://stat.ethz.ch/R-manual/R-patched/library/base/html/delayedAssign.html) para salvar uma promessa que servirá tanto para um aviso quanto para os dados. +## Dados: descontinuar +Se você precisar descontinuar (*deprecate*) um conjunto de dados fornecido pelo seu pacote, +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). +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. ## Funções: descontinuadas e removidas {#functions-deprecate-defunct} Para remover uma função de um pacote (digamos que o nome do seu pacote seja `helloworld`), você pode usar o seguinte protocolo: