datalad.api.meta_report

datalad.api.meta_report(path=None, dataset=None, reporton='all', recursive=False)

Query a dataset’s aggregated metadata for dataset and file metadata

Two types of metadata are supported:

  1. metadata describing a dataset as a whole (dataset-global metadata), and
  2. metadata for files in a dataset (content metadata).

Both types can be queried with this command, and a specific type is requested via the –reporton argument.

Examples

Report the metadata of a single file, the queried dataset is determined based on the current working directory:

% datalad query-metadata somedir/subdir/thisfile.dat

Sometimes it is helpful to get metadata records formatted in a more accessible form, here as pretty-printed JSON:

% datalad -f json_pp query-metadata somedir/subdir/thisfile.dat

Same query as above, but specify which dataset to query (must be containing the query path):

% datalad query-metadata -d . somedir/subdir/thisfile.dat

Report any metadata record of any dataset known to the queried dataset:

% datalad query-metadata --recursive --reporton datasets

Get a JSON-formatted report of metadata aggregates in a dataset, incl. information on enabled metadata extractors, dataset versions, dataset IDs, and dataset paths:

% datalad -f json query-metadata --reporton aggregates
Parameters:
  • path (sequence of str or None, optional) – path(s) to query metadata for. [Default: None]
  • dataset (Dataset or None, optional) – dataset to query. If not given, a dataset will be determined based on the current working directory. [Default: None]
  • reporton ({'all', 'jsonld', 'datasets', 'files', 'aggregates'}, optional) – what type of metadata to report on: dataset-global metadata only (‘datasets’), metadata on dataset content/files only (‘files’), both (‘all’, default). ‘jsonld’ is an alternative mode to report all available metadata with JSON-LD markup. A single metadata result with the entire metadata graph matching the query will be reported, all non-JSON-LD-type metadata will be ignored. There is an auxiliary category ‘aggregates’ that reports on which metadata aggregates are present in the queried dataset. [Default: ‘all’]
  • recursive (bool, optional) – if set, recursively report on any matching metadata based on given paths or reference dataset. Note, setting this option does not cause any recursion into potential subdatasets on the filesystem. It merely determines what metadata is being reported from the given/discovered reference dataset. [Default: False]
  • on_failure ({'ignore', 'continue', 'stop'}, optional) – behavior to perform on failure: ‘ignore’ any failure is reported, but does not cause an exception; ‘continue’ if any failure occurs an exception will be raised at the end, but processing other actions will continue for as long as possible; ‘stop’: processing will stop on first failure and an exception is raised. A failure is any result with status ‘impossible’ or ‘error’. Raised exception is an IncompleteResultsError that carries the result dictionaries of the failures in its failed attribute. [Default: ‘continue’]
  • proc_post – Like proc_pre, but procedures are executed after the main command has finished. [Default: None]
  • proc_pre – DataLad procedure to run prior to the main command. The argument a list of lists with procedure names and optional arguments. Procedures are called in the order their are given in this list. It is important to provide the respective target dataset to run a procedure on as the dataset argument of the main command. [Default: None]
  • result_filter (callable or None, optional) – if given, each to-be-returned status dictionary is passed to this callable, and is only returned if the callable’s return value does not evaluate to False or a ValueError exception is raised. If the given callable supports **kwargs it will additionally be passed the keyword arguments of the original API call. [Default: None]
  • result_renderer ({'default', 'json', 'json_pp', 'tailored'} or None, optional) – format of return value rendering on stdout. [Default: None]
  • result_xfm ({'datasets', 'successdatasets-or-none', 'paths', 'relpaths', 'metadata'} or callable or None, optional) – if given, each to-be-returned result status dictionary is passed to this callable, and its return value becomes the result instead. This is different from result_filter, as it can perform arbitrary transformation of the result value. This is mostly useful for top- level command invocations that need to provide the results in a particular format. Instead of a callable, a label for a pre-crafted result transformation can be given. [Default: None]
  • return_type ({'generator', 'list', 'item-or-list'}, optional) – return value behavior switch. If ‘item-or-list’ a single value is returned instead of a one-item return value list, or a list in case of multiple return values. None is return in case of an empty list. [Default: ‘list’]