datalad export-dtool
Synopsis
datalad export-dtool [-h] [-n NAME] [-d DATASET] [--missing-content {error|continue|ignore}] [--suppress-provenance-annotations] [--version] [BASE_URI]
Description
Export a dtool dataset as a snapshot of a datalad dataset
Long description of arbitrary volume.
Options
BASE_URI
Target base URI where the dtool dataset should be created from specified datalad dataset. Creates dtool dataset in current working directory if not specified. Constraints: value must be a string or value must be NONE
-h, --help, --help-np
show this help message. --help-np forcefully disables the use of a pager for displaying the help message
-n NAME, --name NAME
Name of dtool dataset to be created. Creates dtool dataset of same name as datalad dataset if not specified. Constraints: value must be a string or value must be NONE
-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. 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}
By default, any discovered file with missing content will result in an error and the export 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']
--suppress-provenance-annotations
By default, the export will annotate the freshly created dtool dataset with the DataLad dataset UUID and commit in the fields 'datalad-uuid' and 'datalad- commit'. This option suppresses this behavior.
--version
show the module and its version which provides the command