Skip to content

Commit

Permalink
DOC: minor improvements to README pertaining to validation of process…
Browse files Browse the repository at this point in the history
… files
  • Loading branch information
pebert committed Dec 30, 2016
1 parent 2f6e309 commit 4aa84b8
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# DEEP Computational Metadata

## Identification

This repository can be cited in publications using the following DOI:

[DOI: 10.17617/1.2W](http://doi.org/10.17617/1.2W "https://github.molgen.mpg.de/DEEP/comp-metadata")

Also consider citing the corresponding publication listed [below](#Reference).
Also consider citing the corresponding publication listed under *References*.

## Process documentation

In DEEP, standardized computational analysis pipelines are documented in form of so-called *Process* specifications.
A *Process* document lists required input and reference files, specifies the output generated by the pipeline and
provides a step-by-step description of the computational analysis.
Expand All @@ -16,7 +18,7 @@ provides a step-by-step description of the computational analysis.

[Proceed to Process documents](docs/)

## Creating 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 @@ -25,12 +27,13 @@ and some basic introductory material in this repository:
[Proceed to Process template](template/)

## 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,
an *Analysis* metadata file is created automatically. Consequently, these files are not accessible via this repository.

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

["A general concept for consistent documentation of computational analyses", *Database* 2015](https://dx.doi.org/10.1093/database/bav050)
Expand Down

0 comments on commit 4aa84b8

Please sign in to comment.