DATALAD-EXPORT-TO-FIGSHARE(1)

πŸ’… datalad export-to-figshare β€” the glow-up edition ✨

okay so this is a page from the General Commands Manual, it's datalad export-to-figshare, and bestie it does exactly one thing: it takes your dataset and yeets it out as a ZIP archive over to figshare. iconic. πŸŽ€


🌈 NAME 🌈

datalad export-to-figshare β€” export the content of a dataset as a ZIP archive to figshare πŸ’–


✨ SYNOPSIS ✨

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

like, that's the whole vibe. one command, a bunch of little flags, and a PATH if you're feeling generous 🫢


πŸ¦‹ DESCRIPTION πŸ¦‹

Okay so real talk: this is a very quick and dirty approach. ngl, the ideal world would be figshare being supported as a proper git annex special remote 😭 but figshare does not support having directories, and it can only store a flat list of files. which means any sensible publishing of complete datasets is literally impossible. it's giving "no thoughts, head empty" storage model πŸ’€

so the only workaround is to publish the dataset as a zip-ball β€” the entire content gets wrapped into a .zip archive, and figshare will provide a navigator for it. that's the move. that's the whole plan 🧚


πŸ’… OPTIONS πŸ’…

  • PATH β€” the file name of the generated ZIP archive. if you don't give a file name, the archive gets generated in the top directory of the dataset and will be named: datalad_<dataset_uuid>.zip. Constraints: value must be a string or value must be NONE πŸ“
  • -h, --help, --help-np β€” show this help message. and heads up: --help-np forcefully disables the use of a pager for displaying the help message. no pager, no scrolling drama, just the facts ✨
  • -d DATASET, --dataset DATASET β€” specify the dataset to export. if no dataset is given, an attempt is made to identify the dataset based on the current working directory πŸ‘‘ Constraints: Value must be a Dataset or a valid identifier of a Dataset (e.g. a path) or value must be NONE
  • --missing-content {error|continue|ignore} β€” okay so by default, any discovered file with missing content will result in an error and the plugin is aborted 🚨 Setting this to 'continue' will issue warnings instead of failing on error. The value 'ignore' will only inform about problem at the 'debug' log level. The latter two can be helpful when generating a TAR archive from a dataset where some file content is not available locally. Constraints: value must be one of ('error', 'continue', 'ignore') [Default: 'error']
  • --no-annex β€” by default the generated .zip file would be added to annex, and all files would get registered in git-annex to be available from such a tarball. Also upon upload we will register for that archive to be a possible source for it in annex. Setting this flag disables this behavior πŸ™ˆ
  • --article-id ID β€” which article to publish to. Constraints: value must be convertible to type 'int' or value must be NONE πŸ’œ
  • --version β€” show the module and its version which provides the command. cute little origin story moment ⭐

🌸 AUTHORS 🌸

datalad is developed by The DataLad Team and Contributors <team@datalad.org>. absolute legends, fr fr πŸ’–


okay bestie, quick vibe check before you go: this thing is literally described as "quick and dirty" by its own authors, so like… treat it accordingly. the missing-content defaults will abort on you if a file's content isn't there πŸ’€

and that's the page!! πŸŽ€ written from the datalad export-to-figshare man page, version 1.1.5, dated 2025-06-15, under the General Commands Manual umbrella. go forth and zip-ball your datasets, queen πŸ‘‘βœ¨

πŸ“¦ where this page comes from