Skip to content
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions spec/add.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# `dvs add`

Goal: Add files to an initialized dvs project.

## CLI

```sh
dvs add <FILES> [OPTIONS]

Files:
List of files to add

Options:
-m, --message Message attributed to the add event
--glob Glob expression of the files to add, e.g. (`/phaseA/**/*.csv`)
--json Command output as JSON format
-h, --help

```

`dvs add` will not accept directories as input. However, if all files following a glob expression is to be added, the end-user can use `--glob`/`glob=` in the cli and R package resp.

## R

Signature:

```r
dvs_add <- function(
files = character(), # either files or glob are required
message, # not required, can be missing, `NULL`, "", and character() (empty)
glob = character(), # either files or glob are required
parallel = TRUE # enable parallel
)
```