.TH "datalad drop" "1" "2021\-02\-04" "datalad drop 0.14.0"
.SH NAME
\fBdatalad drop\fR \- drop file content from datasets
.SH SYNOPSIS
.nh
.HP
\fBdatalad drop\fR [-h] [-d\~DATASET] [-r] [-R\~LEVELS] [--nocheck] [--if-dirty {fail,save-before,ignore}] [PATH ...]


.hy
.SH DESCRIPTION

This command takes any number of paths of files and/or directories. If
a common (super)dataset is given explicitly, the given paths are
interpreted relative to this dataset.
.PP
Recursion into subdatasets needs to be explicitly enabled, while recursion
into subdirectories within a dataset is done automatically. An optional
recursion limit is applied relative to each given input path.
.PP
By default, the availability of at least one remote copy is verified before
file content is dropped. As these checks could lead to slow operation
(network latencies, etc), they can be disabled.
.PP
.SS Examples
.PP
Drop single file content::
.PP
 % datalad drop <path/to/file>
.PP
Drop all file content in the current dataset::
.PP
 % datalad drop
.PP
Drop all file content in a dataset and all its subdatasets::
.PP
 % datalad drop \-d <path/to/dataset> \-r
.PP
Disable check to ensure the configured minimum number of remote
sources for dropped data::
.PP
 % datalad drop <path/to/content> \-\-nocheck

.SH OPTIONS
.TP
PATH
path/name of the component to be dropped. Constraints: value must be a string

.TP
\fB-h\fR, \fB--help\fR, \fB--help-np\fR
show this help message. --help-np forcefully disables the use of a pager for displaying the help message
.TP
\fB-d\fR DATASET, \fB--dataset\fR 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)
.TP
\fB-r\fR, \fB--recursive\fR
if set, recurse into potential subdataset.
.TP
\fB-R\fR LEVELS, \fB--recursion-limit\fR LEVELS
limit recursion into subdataset to the given number of levels. Constraints: value must be convertible to type 'int'
.TP
\fB--nocheck\fR
whether to perform checks to assure the configured minimum number (remote) source for data. Give this option to skip checks.
.TP
\fB--if-dirty\fR {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']
.SH AUTHORS
 datalad is developed by The DataLad Team and Contributors <team@datalad.org>.