Skip to content

Commit

Permalink
Add documentation on how to work with tags
Browse files Browse the repository at this point in the history
  • Loading branch information
Tjelvar Olsson committed Mar 24, 2020
1 parent fffe481 commit 66f59d0
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ files & metadata into self contained datasets.
philosophy
quick_start_guide
working_with_datasets
tagging_datasets
annotating_datasets
working_with_overlays
configuring_user_name_and_email
Expand Down
27 changes: 27 additions & 0 deletions docs/source/tagging_datasets.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Tagging datasets
================

It is possible to tag datasets with labels.

To tag a dataset with the label "rnaseq" one would use the command below::

$ dtool tag set <DS_URI> rnaseq

It is possible to add more than one tag to a dataset. The command below
adds the tag "A.thaliana"::

$ dtool tag set <DS_URI> A.thaliana

To list tags one would use the command below:

$ dtool tag ls <DS_URI>

This would produce the output::

A.thalina
rnaseq

It is possible to delete a tag that has been added to a dataset::


$ dtool tag delete <DS_URI> A.thaliana

0 comments on commit 66f59d0

Please sign in to comment.