Add new doc section DataLad-based deposition #2
Loading…
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
These instructions would be for users who have adopted DataLad in their sfb1451 data workflows. There are two concrete scenarios:
selfwith atabbyrecord, such that we can clone the dataset and harvest that record (plus all the basic file info).tabbyrecords in the most efficient way that can then be put into the respective project superdataset (by them or by us).The content that we want to add seem to me to fall nicely under
Submitting a record -> DataLad-based deposition(here: https://rdm.sfb1451.de/data-catalog-submission/#submitting-a-record) so i think it would make sense to addDataLad-based depositionas the new section underneathRecord components.A more concrete suggestion for the structure of the additional docs:
DataLad-based deposition
Scenario 1: A shareable DataLad dataset
.datalad/tabby/self/dataset.tsv, this location is relative to the root of the DataLad dataset that is being described. (should any mention be made of conventions?).datalad/tabby/collection/location relative to the root of the DataLad dataset.datalad save -m "<save message>"datalad push --to sciebo. This assumes that the user is familiar with and has followed the data publication procedure outlined in https://rdm.sfb1451.de/publication-catalog/ for the DataLad dataset under consideration.Scenario 2: A NON-shareable DataLad dataset
filestable (see: https://rdm.sfb1451.de/data-catalog-submission/#table-files), users can run thedatalad-tabby/tools/dir2filetable.pyscript provided in thedatalad-tabbyrepository:tabby?) in the SFB1451 project box on Sciebo (see: https://rdm.sfb1451.de/publication-catalog/#preliminary-sciebo-access) and/or follow the data publication procedure outlined here https://rdm.sfb1451.de/publication-catalog/ if publishing via DataLad.datalad save -m "<save message>"(this would be for the users' own benefit and future use)Additional options
Subdataset linkage
.datalad/tabby/collection?...
Re place: logically it makes sense, the only reason why we may consider a separate page is to avoid the page with non-DataLad deposition looking scarily long.
I like the suggestion, I think it is concise and contains the relevant message. A couple of comments below.
Scenario 1
That's a bit of a shortcut - as it stands, for our SFB goals we require dataset, data controller, authors & funding. Unless going straight for json, these would have to be four tsv files.
Good Q - when saving files sent to me by e-mail I add a convention name (I even have a script to do that). A convention defines json-ld context but is also used to declare which files should be loaded (added to json structure) when reading dataset.tsv. I have my convention here
FYI, that's not documented / not communicated broadly, but I finally mirrored all Sciebo datasets to GitHub. Accidentally made GitHub repos private, too...
Scenario 2
I'll need to try that on a DataLad dataset, but seeing that the script contains
relpath.glob('*')I'm concerned it may try to list.gitas well. Maybegit ls-filesorgit ls-treeor something based on iter_gitworktree would be better? In any case, the suggestion is good, but the script may need to change.I like this point, and I think it's a good idea to separate the content.
Indeed, clearer to specify all the TSV files that need to form part of the deposited record.
The context behind
datalad-tabby/tools/dir2filetable.pyis here https://github.com/psychoinformatics-de/datalad-tabby/issues/33 and here https://github.com/psychoinformatics-de/datalad-tabby/pull/60. So indeed we could opt for a different solution given that the users at which these docs are targeted would already be using datalad. Alternatively the script could be updated to exclude hidden files by default, and include them with a flag (this would be a good addition to the script in any case).This has long been closed by !27