Support scoping within Dataverse datasets #273
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This brings it to:
```
❯ git annex initremote dv type=external externaltype=dataverse -w
readonly
enable readonly mode
(true or false)
chunk
size of chunks (eg, 1MiB)
encryption
how to encrypt data stored in the special remote
(hybrid or none or pubkey or shared or sharedpubkey)
embedcreds
embed credentials into git repository
(yes or no)
mac
how to encrypt filenames used on the remote
(HMACSHA1 or HMACSHA224 or HMACSHA256 or HMACSHA384 or HMACSHA512)
keyid
gpg key id
keyid+
add additional gpg key
keyid-
remove gpg key
credential
name of a DataLad credential with a Dataverse API token to use
doi
DOI-style persistent identifier of the Dataverse dataset
url
URL of the Dataverse site
```
As a replacement of dedicated support for recursive deposition, `add_sibling_dataverse` now supports a `root_path` option (`None` by default) that enables users to identify a root `directoryLabel` for a particular DataLad dataset inside a Dataverse dataset. This option is mirrored as `rootpath=` for the special remote. `add_sibling_dataverse` merely passes it through. It is implemented as a front-end to `mangle_path()` within `OnlineDataverseDataset` and limits all path-based operations to be within a given root. This now makes it possible to represent any number of DataLad datasets in a single Dataverse dataset. This approachs matches the requirement to create Dataverse datasets manually, and does not constrain automation of data deposition with large DataLad dataset hierarchies. Providing a `root_path` rather than `--recursive` enables users to choose their own organization of subdatasets within the Dataverse dataset, rather than imposing a select few. Recursive operation could be done by users via `for_each_dataset`. A test is included that documents the ability to deposit nested dataset hierarchies and re-clone them recursively. Closes datalad#271
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #273 +/- ##
==========================================
+ Coverage 93.39% 93.61% +0.21%
==========================================
Files 17 17
Lines 909 939 +30
==========================================
+ Hits 849 879 +30
Misses 60 60
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As a replacement of dedicated support for recursive deposition,
add_sibling_dataversenow supports aroot_pathoption (Nonebydefault) that enables users to identify a root
directoryLabelfor aparticular DataLad dataset inside a Dataverse dataset. This option is
mirrored as
rootpath=for the special remote.add_sibling_dataversemerely passes it through.
It is implemented as a front-end to
mangle_path()withinOnlineDataverseDatasetand limits all path-based operations to bewithin a given root.
This now makes it possible to represent any number of DataLad datasets
in a single Dataverse dataset. This approachs matches the requirement to
create Dataverse datasets manually, and does not constrain automation of
data deposition with large DataLad dataset hierarchies. Providing
a
root_pathrather than--recursiveenables users to choose their ownorganization of subdatasets within the Dataverse dataset, rather than
imposing a select few. Recursive operation could be done by users via
for_each_dataset.A test is included that documents the ability to deposit nested dataset
hierarchies and re-clone them recursively.
Closes #271