datalad-aggregate-metadata

Synopsis

datalad-aggregate-metadata [-h] [-d DATASET] [--guess-native-type] [-r] [--recursion-limit LEVELS] [--nosave] [--if-dirty {fail,save-before,ignore}]

Description

Aggregate meta data of a dataset for later query.

By default meta data is aggregated across all configured native meta data sources. Optionally, the type of available meta data can guessed, if no types are configures. Moreover, it is possible to aggregate meta data from any subdatasets into the superdataset, in order to facilitate data discovery without having to obtain any subdataset.

Options

-h, –help, –help-np

show this help message. –help-np forcefully disables the use of a pager for displaying the help message

-d DATASET, –dataset DATASET

specify the dataset to perform the install operation on. If no dataset is given, an attempt is made to identify the dataset based on the current working directory and/or the PATH given. Constraints: Value must be a Dataset or a valid identifier of a Dataset (e.g. a path)

–guess-native-type

guess native meta data type of datasets, if none is configured. With a configured, or auto-detected meta data type, no native meta data will be aggregated. [Default: False]

-r, –recursive

if set, recurse into potential subdataset. [Default: False]

–recursion-limit LEVELS

limit recursion into subdataset to the given number of levels. Constraints: value must be convertible to type ‘int’ [Default: None]

–nosave

by default all modifications to a dataset are immediately saved. Given this option will disable this behavior. [Default: True]

–if-dirty {fail,save-before,ignore}

desired behavior if a dataset with unsaved changes is discovered: ‘fail’ will trigger an error and further processing is aborted; ‘save-before’ will save all changes prior any further action; ‘ignore’ let’s datalad proceed as if the dataset would not have unsaved changes. [Default: ‘save-before’]

Authors

datalad is developed by The DataLad Team and Contributors <team@datalad.org>.