updated readme
This commit is contained in:
parent
2c5e27fee8
commit
e875c500a4
2 changed files with 8 additions and 35 deletions
38
README.md
38
README.md
|
@ -1,33 +1,26 @@
|
||||||
mCSM Analysis
|
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`
|
1. git repos are cloned to `~/git`
|
||||||
2. The script
|
2. Requires a `Data/` in `~/git` which has the struc created by `mk-drug-dirs.sh`
|
||||||
|
|
||||||
## LSHTM\_analysis: Repo
|
## LSHTM\_analysis:
|
||||||
|
|
||||||
subdirs
|
subdirs
|
||||||
|
|
||||||
needs to call `../Data/input/original/`
|
|
||||||
|
|
||||||
meta\_data\_analysis/
|
meta\_data\_analysis/
|
||||||
*.R
|
*.R
|
||||||
*.py
|
*.py
|
||||||
|
|
||||||
needs to call `../Data/input/processed/<drug>`
|
|
||||||
needs to output `../Data/output/results/<drug>`
|
|
||||||
|
|
||||||
mcsm\_analysis/
|
mcsm\_analysis/
|
||||||
<drug>/ (generated by `meta_data_analysis/pnca_data_extraction.py`. To be replaced with command line args or config option "soon")
|
<drug>/ (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
|
*.R
|
||||||
*.py
|
*.py
|
||||||
mcsm/
|
mcsm/
|
||||||
|
@ -37,23 +30,4 @@ Requires an additional 'Data' directory (Supplied separately). Batteries not inc
|
||||||
plotting/
|
plotting/
|
||||||
*.R
|
*.R
|
||||||
|
|
||||||
|
|
||||||
Data: Repo:
|
|
||||||
|
|
||||||
# subdirs
|
|
||||||
|
|
||||||
input/
|
|
||||||
original/
|
|
||||||
processed/
|
|
||||||
|
|
||||||
output/
|
|
||||||
<drug>/ (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.
|
More docs here as I write them.
|
||||||
|
|
|
@ -1,8 +1,7 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
# Create a drug directory structure for processing
|
# Create a drug directory structure for processing
|
||||||
#
|
#
|
||||||
#
|
## Structure:
|
||||||
# Structure:
|
|
||||||
#
|
#
|
||||||
# $DATA_DIR/$DRUG/input
|
# $DATA_DIR/$DRUG/input
|
||||||
# |- original
|
# |- original
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue