Browse Source

DOC: add a minimal README as a description

Adina Wagner 3 years ago
parent
commit
b87a00ee2a
1 changed files with 28 additions and 5 deletions
  1. 28 5
      README.md

+ 28 - 5
README.md

@@ -1,7 +1,30 @@
-# Project <insert name>
+# Preprocessed structural data from the studyforrest project
 
-## Dataset structure
+This dataset contains the results of an fMRIprep-based, anatomical preprocessing
+workflow of structural studyforrest data (studyforrest.org).
+
+All results are fully and automatically reproducible with
+[datalad](http://www.datalad.org). The details of this workflow are described at
+https://github.com/psychoinformatics-de/processing-workflow.
+
+## Software requirements for automatic recomputation
+
+- [DataLad](http://www.datalad.org)
+- [Singularity](https://sylabs.io/docs/)
+
+## How to recompute
+
+First, clone this dataset with DataLad.
+Next, take a look at the Git history of the data and identify the 40-character long
+commit shasum of a single-subject computation, then use this shasum in a
+``datalad rerun`` command:
+
+```
+$ datalad rerun a95484c793793b7274dbef5239e0cc3d315ca0fe
+```
+
+## How to obtain data without recomputation
+
+First, cline this dataset with DataLad.
+Next, retrieve any file(s) of your choice with the ``datalad get`` command.
 
-- All inputs (i.e. building blocks from other sources) are located in
-  `inputs/`.
-- All custom code is located in `code/`.