From 11e28b38ed31692e56b868aa5f3ca906e8cc8279 Mon Sep 17 00:00:00 2001 From: Alejandra Gonzalez-Beltran Date: Thu, 28 Jun 2018 17:05:50 -0700 Subject: [PATCH] Added some documentation in the README --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f022df0..d0a65ca 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ [![Build Status](https://travis-ci.org/CellMigStandOrg/CMSO-datasets.svg?branch=master)](https://travis-ci.org/CellMigStandOrg/CMSO-datasets) +[![Python 3.6](https://img.shields.io/badge/python-3.6-blue.svg)](https://www.python.org/downloads/release/python-360/) CMSO datasets ============= @@ -19,10 +20,32 @@ After the curation is performed, the expected metadata files represent the three How to add a new dataset? ------------------------- -In order to submit a new dataset, a minimal set of information needs to be provided. +In order to submit a new dataset, a minimal set of information needs to be provided based on the [MIACME](https://github.com/CellMigStandOrg/MIACME) guidelines. How to propose changes to an existing dataset? ---------------------------------------------- We welcome issues in the [tracker](https://github.com/CellMigStandOrg/CMSO-datasets/issues) as well as Pull Requests suggesting changes to the datasets available in this repository. + +How to run the dataset validation code from this repository? +------------------------------------------------------------ + +If you would like to run locally the dataset validation code from this repository, you can follow the following steps: + +1. Clone the repository + ```git clone https://github.com/CellMigStandOrg/CMSO-datasets``` +1. We suggest you use a python virtual environment. So, if not already installed in your system, first install the virtual environment via `pip`: + `pip install virtualenv` +1. Create a virtual environment: + `virtualenv venv` +1. Then, activate the virtual environment: + `source venv/bin/activate` +1. Install the requirements: + `pip install -r requirements.txt` +1. Validate the ISA metadata: + `python check_isa.py` +1. Validate the biotracks datapackage: + `python check_dpkg.py` + +