Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Adina Wagner <[email protected]>
  • Loading branch information
mslw and adswa authored Jan 10, 2024
1 parent 7bebdd2 commit 2d2e21e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 6 additions & 0 deletions docs/source/user/datalad-access.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@ Given the exemplary values above, the pattern would expand to
'datalad-annex::?type=external&externaltype=uncurl&encryption=none&url=file:///data/group/groupname/local_dicom_store/my-study/P000123_{{annex_key}}'
A full ``datalad clone`` command could then look like this:

.. code-block::
datalad clone 'datalad-annex::?type=external&externaltype=uncurl&encryption=none&url=file:///tmp/local_dicom_store/dl-Z03/P000624_{{annex_key}}' my_clone
.. note:: The URL is arguably a bit clunky. A convenience short cut can be provided via configuration item ``datalad.clone.url-substitute.<label>`` and a substitution rule based on regular expressions. For example, clone URLs can be shortened to require only an identifier (here, ``file:///data/group/groupname/local_dicom_store``), study ID, and visit ID (``inm-icf/<study-ID>/<visit-ID>``) with the following configuration:

.. code-block::
Expand Down
2 changes: 1 addition & 1 deletion docs/source/user/datalad-generate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Download the visit tarball, keeping the same relative path:

.. code-block:: bash
datalad download "https://data.inm-icf.de/<project-ID>/<visit-ID>_dicom.tar <project-ID>/<visit-ID>_dicom.tar"
datalad download "https://data.inm-icf.de/<project-ID>/<visit-ID>_dicom.tar local_dicom_store/<project-ID>/<visit-ID>_dicom.tar"
Using ``datalad download`` for downloading the file has the benefit of
using DataLad's credential management. If this is the first time you
Expand Down

0 comments on commit 2d2e21e

Please sign in to comment.