Skip to content

Commit

Permalink
add desc of version deletion to versioning vignette for #77
Browse files Browse the repository at this point in the history
  • Loading branch information
mpadge committed Jun 15, 2023
1 parent 71f882a commit 15777e7
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -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", , "[email protected]", role = c("aut", "cre"),
comment = c(ORCID = "0000-0003-2172-5265"))
Expand Down
2 changes: 1 addition & 1 deletion codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
11 changes: 11 additions & 0 deletions vignettes/versioning.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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-).

0 comments on commit 15777e7

Please sign in to comment.