From 15777e73951517c2dca78b72cfd94057a5aa422c Mon Sep 17 00:00:00 2001 From: mpadge Date: Thu, 15 Jun 2023 13:41:29 +0200 Subject: [PATCH] add desc of version deletion to versioning vignette for #77 --- DESCRIPTION | 2 +- codemeta.json | 2 +- vignettes/versioning.Rmd | 11 +++++++++++ 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 7a7be7d8..f6d7421b 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: deposits Title: A universal client for depositing and accessing research data anywhere -Version: 0.2.1.034 +Version: 0.2.1.035 Authors@R: person("Mark", "Padgham", , "mark.padgham@email.com", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-2172-5265")) diff --git a/codemeta.json b/codemeta.json index 3dd23e36..7b4fced6 100644 --- a/codemeta.json +++ b/codemeta.json @@ -7,7 +7,7 @@ "codeRepository": "https://github.com/ropenscilabs/deposits", "issueTracker": "https://github.com/ropenscilabs/deposits/issues", "license": "https://spdx.org/licenses/MIT", - "version": "0.2.1.034", + "version": "0.2.1.035", "programmingLanguage": { "@type": "ComputerLanguage", "name": "R", diff --git a/vignettes/versioning.Rmd b/vignettes/versioning.Rmd index 4f135bd6..98351be4 100644 --- a/vignettes/versioning.Rmd +++ b/vignettes/versioning.Rmd @@ -78,6 +78,12 @@ method](https://docs.ropensci.org/deposits/reference/depositsClient.html#method- The primary URL of the deposit will then resolve to the latest published version. +Versions created with the [`deposit_version()` +method](https://docs.ropensci.org/deposits/reference/depositsClient.html#method-deposit-version-) +are private until published. These versions may also be cancelled or deleted by +calling +[`cli$deposit_delete()`](https://docs.ropensci.org/deposits/reference/depositsClient.html#method-deposit-delete-). + # Services without explicit version control Figshare does not offer explicit control of versions. Instead, a deposit may be @@ -100,3 +106,8 @@ The only difference to the workflow for Zenodo is that [`deposit_update()` method](https://docs.ropensci.org/deposits/reference/depositsClient.html#method-deposit-update-) is called instead of [`deposit_version()` method](https://docs.ropensci.org/deposits/reference/depositsClient.html#method-deposit-version-). +Any updates created with the [`deposit_update()` +method](https://docs.ropensci.org/deposits/reference/depositsClient.html#method-deposit-update-) +are private until published. These updates may also be cancelled or deleted by +calling +[`cli$deposit_delete()`](https://docs.ropensci.org/deposits/reference/depositsClient.html#method-deposit-delete-).