From e2951327e1fffaa3df0e902d12f38cfde29bf51c Mon Sep 17 00:00:00 2001 From: Peter Ebert Date: Thu, 20 Oct 2016 22:30:27 +0200 Subject: [PATCH] MAINT: extended central README --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 41fdafb..d208f14 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ # 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). + ## 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 @@ -7,6 +14,11 @@ provides a step-by-step description of the computational analysis. *Processes* are in XML format and are rendered into a readable form when opened in a standard web browser (assuming an active internet connection). They are lightweight enough to be send via e-mail to collaboration partners. +[Proceed to Process documentation](docs/process.md) + +## Creating new *Process* documents + + ## 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* @@ -16,4 +28,6 @@ an *Analysis* metadata file is created automatically. Consequently, these files ## Reference 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) \ No newline at end of file +["A general concept for consistent documentation of computational analyses", *Database* 2015](https://dx.doi.org/10.1093/database/bav050) + +The [supplemental material](publication/suppmat.md) is also available in this repository. Please note that this material is just kept for reference, and is considered outdated. Please **do not use it** to create new *Process* documents. \ No newline at end of file