From 253f35135a8b74b540278b7418d2dee836c0230a Mon Sep 17 00:00:00 2001 From: Peter Ebert Date: Thu, 20 Oct 2016 10:18:22 +0200 Subject: [PATCH] MAINT: initial commit of content in readme, adapted gitignore to include PyCharm folder --- .gitignore | 3 +++ README.md | 20 ++++++++++++++++++-- 2 files changed, 21 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 72364f9..0a772ad 100644 --- a/.gitignore +++ b/.gitignore @@ -87,3 +87,6 @@ ENV/ # Rope project settings .ropeproject + +# PyCharm folder +.idea/ diff --git a/README.md b/README.md index 2b6cadc..1543866 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ -# comp-metadata -DEEP: specification of computational metadata and documentation of analysis pipelines (Process files) +# DEEP Computational Metadata + +## 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. +*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. + +## 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 +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