1datalad export-to-figshare(1)General Commands Manuadlatalad export-to-figshare(1)
2
3
4

NAME

6       datalad  export-to-figshare  - export the content of a dataset as a ZIP
7       archive to figshare
8

SYNOPSIS

10       datalad    export-to-figshare    [-h]    [-d    DATASET]    [--missing-
11              content  {error|continue|ignore}] [--no-annex] [--article-id ID]
12              [--version] [PATH]
13
14
15

DESCRIPTION

17       Very quick and dirty approach.  Ideally figshare should be supported as
18       a  proper  git  annex special remote.  Unfortunately, figshare does not
19       support having directories, and can store only a flat  list  of  files.
20       That  makes  it  impossible  for  any  sensible  publishing of complete
21       datasets.
22
23       The only workaround is to publish dataset as a zip-ball, where the  en‐
24       tire  content  is  wrapped into a .zip archive for which figshare would
25       provide a navigator.
26

OPTIONS

28       PATH   File name of the generated ZIP archive. If no file name is given
29              the  archive  will  be  generated  in  the  top directory of the
30              dataset and  will  be  named:  datalad_<dataset_uuid>.zip.  Con‐
31              straints: value must be a string or value must be NONE
32
33
34       -h, --help, --help-np
35              show this help message. --help-np forcefully disables the use of
36              a pager for displaying the help message
37
38       -d DATASET, --dataset DATASET
39              "specify the dataset to export. If no dataset is given,  an  at‐
40              tempt is made to identify the dataset based on the current work‐
41              ing directory. Constraints: Value must be a Dataset or  a  valid
42              identifier of a Dataset (e.g. a path) or value must be NONE
43
44       --missing-content {error|continue|ignore}
45              By default, any discovered file with missing content will result
46              in an error and the plugin is aborted. Setting this to  'contin‐
47              ue'  will  issue warnings instead of failing on error. The value
48              'ignore' will only inform about problem at the 'debug' log  lev‐
49              el.  The latter two can be helpful when generating a TAR archive
50              from a dataset where some file content is not available locally.
51              Constraints:  value  must  be  one of ('error', 'continue', 'ig‐
52              nore') [Default: 'error']
53
54       --no-annex
55              By default the generated .zip file would be added to annex,  and
56              all files would get registered in git-annex to be available from
57              such a tarball. Also upon upload we will register for  that  ar‐
58              chive to be a possible source for it in annex. Setting this flag
59              disables this behavior.
60
61       --article-id ID
62              Which article to publish to. Constraints: value must be convert‐
63              ible to type 'int' or value must be NONE
64
65       --version
66              show the module and its version which provides the command
67

AUTHORS

69        datalad is developed by The DataLad Team and Contributors <team@datal‐
70       ad.org>.
71
72
73
74datalad export-to-figshare 0.19.3 2023-08-11     datalad export-to-figshare(1)
Impressum