From e875c500a4adb7206fc2978f2147cd9af82944bf Mon Sep 17 00:00:00 2001 From: Tanushree Tunstall Date: Wed, 8 Jan 2020 17:11:19 +0000 Subject: [PATCH] updated readme --- README.md | 40 +++++++--------------------------------- mk-drug-dirs.sh | 3 +-- 2 files changed, 8 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 1fe45f7..01483b4 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,26 @@ mCSM Analysis ============= -This repo does mCSM analysis using Python (Pandas, numpy), bash and R. +This repo does mCSM analysis using Python, bash and R. -Requires an additional 'Data' directory (Supplied separately). Batteries not included. +Requires an additional 'Data' directory. Batteries not included. - # directory struc - - # Assumptions + # Assumptions 1. git repos are cloned to `~/git` - 2. The script - -## LSHTM\_analysis: Repo + 2. Requires a `Data/` in `~/git` which has the struc created by `mk-drug-dirs.sh` +## LSHTM\_analysis: + subdirs - needs to call `../Data/input/original/` - meta\_data\_analysis/ *.R *.py - needs to call `../Data/input/processed/` - needs to output `../Data/output/results/` - mcsm\_analysis/ / (generated by `meta_data_analysis/pnca_data_extraction.py`. To be replaced with command line args or config option "soon") - scripts/ (changed from `Scripts/`) + scripts/ *.R *.py mcsm/ @@ -37,23 +30,4 @@ Requires an additional 'Data' directory (Supplied separately). Batteries not inc plotting/ *.R - -Data: Repo: - - # subdirs - - input/ - original/ - processed/ - - output/ - / (generated by `meta_data_analysis/pnca_data_extraction.py`. To be replaced with command line args or config option "soon") - results/ - *.csv - *.xlsx - *.doc - *.txt - plots/ - structure/ - More docs here as I write them. diff --git a/mk-drug-dirs.sh b/mk-drug-dirs.sh index 56fb820..6a6dd6d 100755 --- a/mk-drug-dirs.sh +++ b/mk-drug-dirs.sh @@ -1,8 +1,7 @@ #!/bin/bash # Create a drug directory structure for processing # -# -# Structure: +## Structure: # # $DATA_DIR/$DRUG/input # |- original