datalad annotate-paths(1) | General Commands Manual | datalad annotate-paths(1) |
datalad annotate-paths - analyze and act upon input paths
datalad annotate-paths [-h] [-d DATASET] [-r] [-R LEVELS] [--action LABEL] [--unavailable-path-status LABEL] [--unavailable-path-msg message] [--nondataset-path-status LABEL] [--no-parentds-discovery] [--no-subds-discovery] [--revision-change-discovery] [--no-untracked-discovery] [--modified [MODIFIED]] [PATH ...]
Given paths (or more generally location requests) are inspected and annotated with a number of properties. A list of recognized properties is provided below.
"action"
label of the action that triggered the path annotation
"annexkey"
annex key for the content of a file
"logger"
logger for reporting a message
"message"
message (plus possible tsring expansion arguments)
"orig_request"
original input by which a path was determined
"parentds"
path of dataset containing the annotated path (superdataset
for subdatasets)
"path"
absolute path that is annotated
"process_content"
flag that content underneath the path is to be processed
"process_updated_only"
flag that only known dataset components are to be processed
"raw_input"
flag whether this path was given as raw (non-annotated) input
"refds"
path of a reference/base dataset the annotated path is part of
"registered_subds"
flag whether a dataset is known to be a true subdataset of
PARENTDS
"revision"
the recorded commit for a subdataset in a superdataset
"revision_descr"
a human-readable description of REVISION
"source_url"
URL a dataset was installed from
"staged"
flag whether a path is known to be "staged" in its containing
dataset
"state"
state indicator for a path in its containing dataset (clean,
modified, absent (also for files), conflict)
"status"
action result status (ok, notneeded, impossible, error)
"type"
nature of the path (file, directory, dataset)
"url"
registered URL for a subdataset in a superdataset
In the case of enabled modification detection the results may contain additional properties regarding the nature of the modification. See the documentation of the DIFF command for details.
datalad is developed by The DataLad Team and Contributors <team@datalad.org>.
2021-02-04 | datalad annotate-paths 0.14.0 |