DOC: update DataLad access instructions #22

Merged
loj merged 1 commit from README into master 2021-04-28 08:19:17 +00:00

View file

@ -56,17 +56,77 @@ algorithm parameters are also rendered into the picture.
How to obtain the dataset
-------------------------
This is a DataLad dataset. It can be installed via::
This repository is a `DataLad <https://www.datalad.org/>`__ dataset. It provides
fine-grained data access down to the level of individual files, and allows for
tracking future updates. In order to use this repository for data retrieval,
`DataLad <https://www.datalad.org>`_ is required.
It is a free and open source command line tool, available for all
major operating systems, and builds up on Git and `git-annex
<https://git-annex.branchable.com>`__ to allow sharing, synchronizing, and
version controlling collections of large files. You can find information on
how to install DataLad at `handbook.datalad.org/en/latest/intro/installation.html
<http://handbook.datalad.org/en/latest/intro/installation.html>`_.
datalad install \
https://github.com/psychoinformatics-de/studyforrest-data-eyemovementlabels.git
Get the dataset
^^^^^^^^^^^^^^^
once installed, any file content can be obtained via::
A DataLad dataset can be ``cloned`` by running::
datalad get <somepath> # e.g.: datalad get .
datalad clone https://github.com/psychoinformatics-de/studyforrest-data-eyemovementlabels.git
Please refer to https://www.datalad.org for information on how to install
DataLad, and how to work with DataLad datasets.
Once a dataset is cloned, it is a light-weight directory on your local machine.
At this point, it contains only small metadata and information on the
identity of the files in the dataset, but not actual *content* of the
(sometimes large) data files.
Retrieve dataset content
^^^^^^^^^^^^^^^^^^^^^^^^
After cloning a dataset, you can retrieve file contents by running::
datalad get <path/to/directory/or/file>
This command will trigger a download of the files, directories, or
subdatasets you have specified.
DataLad datasets can contain other datasets, so called *subdatasets*. If you
clone the top-level dataset, subdatasets do not yet contain metadata and
information on the identity of files, but appear to be empty directories. In
order to retrieve file availability metadata in subdatasets, run::
datalad get -n <path/to/subdataset>
Afterwards, you can browse the retrieved metadata to find out about
subdataset contents, and retrieve individual files with ``datalad get``. If you
use ``datalad get <path/to/subdataset>``, all contents of the subdataset will
be downloaded at once.
Stay up-to-date
^^^^^^^^^^^^^^^
DataLad datasets can be updated. The command ``datalad update`` will *fetch*
updates and store them on a different branch (by default
``remotes/origin/master``). Running::
datalad update --merge
will *pull* available updates and integrate them in one go.
Find out what has been done
^^^^^^^^^^^^^^^^^^^^^^^^^^^
DataLad datasets contain their history in the ``git log``.
By running ``git log`` (or a tool that displays Git history) in the dataset or on
specific files, you can find out what has been done to the dataset or to individual files
by whom, and when.
More information
^^^^^^^^^^^^^^^^
More information on DataLad and how to use it can be found in the DataLad Handbook at
`handbook.datalad.org <http://handbook.datalad.org/en/latest/index.html>`_. The
chapter "DataLad datasets" can help you to familiarize yourself with the
concept of a dataset.
.. |license|