Skip to content

Commit

Permalink
DOC: added link to DEEP data portal
Browse files Browse the repository at this point in the history
  • Loading branch information
pebert committed Dec 30, 2016
1 parent 4aa84b8 commit b1725b7
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ provides a step-by-step description of the computational analysis.

[Proceed to Process documents](docs/)

## Creating and validating new *Process* documents
## Creating and validating new Process documents

If you want to document a new analysis type, i.e., a standardized pipeline, or if you just want to document
an analysis specific for a DEEP publication, you can download the *Process* template file
Expand All @@ -28,11 +28,15 @@ and some basic introductory material in this repository:

## Analysis documentation

Each run of a standardized pipeline produces an *Analysis* metadata document at the end. These are simple tab-separated
text files listing all input, output and reference files as well as non-default parameters in form of *key-value*
entries. Whereas a *Process* document has to be manually created and describes an analysis pipeline in generic form,
Each run of a standardized pipeline is supposed to produce an *Analysis* metadata document at the end
(named like this: `DEEP-ID.PROCESS.DATE.amd.tsv`). These are simple tab-separated text files listing all input,
output and reference files as well as non-default parameters in form of *key-value* entries.
Whereas a *Process* document has to be manually created and describes an analysis pipeline in generic form,
an *Analysis* metadata file is created automatically. Consequently, these files are not accessible via this repository.

If you are looking for the *Analysis* metadata files, please refer to the official [DEEP data portal](http://deep.dkfz.de) hosted
by the DEEP *Data Collection Center* (DCC - DKFZ Heidelberg).

## References
See the corresponding publication in Oxford Database for details:

Expand Down

0 comments on commit b1725b7

Please sign in to comment.