bionic (1) datalad-remove.1.gz

SYNOPSIS

       datalad-remove  [-h]  [-d  DATASET]  [-r]  [--nocheck]  [--nosave]  [-m  MESSAGE] [--if-dirty {fail,save-
              before,ignore}] [PATH [PATH ...]]

DESCRIPTION

       Remove components from datasets

       This command can remove any  components  (subdatasets,  and  (directories  with)  files)  from  datasets.
       Removing  a  component  implies  any  present content to be dropped, and any associated subdatasets to be
       uninstalled. Subsequently, the component is "unregistered" from the respective dataset. This  means  that
       the respective component is no longer present on the file system.

       By  default, the availability of at least one remote copy is verified, by default, before file content is
       dropped. As these checks could lead to slow operation (network latencies, etc), they can be disabled.

       Any number of paths to process can be given as input. Recursion into subdatasets needs to  be  explicitly
       enabled,  while  recursion  in  subdirectories within a dataset as always done automatically. An optional
       recursion limit is applied relative to each given input path.

       Examples:

       Permanently remove a subdataset from a dataset and wipe out the subdataset association too::

         ~/some/dataset$ datalad remove somesubdataset1

OPTIONS

       PATH   path/name of the component to be removed. Constraints: value must be a string [Default: None]

       -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 operation on. If no dataset is given, an attempt is made to
              identify a dataset based on the PATH given. Constraints: Value  must  be  a  Dataset  or  a  valid
              identifier of a Dataset (e.g. a path) [Default: None]

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

       --nocheck
              whether  to  perform checks to assure the configured minimum number (remote) source for data. Give
              this option to skip checks. [Default: True]

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

       -m MESSAGE, --message MESSAGE
              a  description  of the state or the changes made to a dataset. Constraints: value must be a string
              [Default: None]

       --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>.