Merge pull request #5 from BushmanLab/use_sites_from_db

Use sites from db

Author: anatolydryga

README.md

@@ -1,35 +1,55 @@
-# Database connfig file location
+# Genomic Heatmap Maker for Integration Sites
 
-config file should be in home directory and called .my.cnf,
-e.g. ~/.my.cnf
 
-The .my.cnf format is as follows:
+# Script to run genomic heatmap maker from sites from DB
 
+For list of GTSP and replicates generate heatmap
+for a given reference genome and given integration site database:
 ```
-[intSitesDEV-dev]
+Rscript genomicHeatmapMaker.R sampleName_GTSP.csv -o heatmap --ref_genome hg18  -sites_group intSitesDev237
+```
+Group should be present in ~/.my.cnf.
+
+File `sampleName_GTSP.csv` should have at least 2 columns: sampleName and GTSP.
+If column `label` is given it will be used as a label in heatmap otherrwise GTSP will be used.
+All replicates of given GTSP merged together. See geneTherapyPatientReportMaker and intSiteCaller
+for instruction how to generate `sampleName_GTSP.csv`.
+
+Defaults: reference genome is "hg18" and sites group is "intsites_miseq".
+
+
+# Database configuration file 
+
+Configuration file should be in home directory and called .my.cnf,
+(~/.my.cnf).
+
+The .my.cnf format is:
+
+```
+[group_name]
 user=YYYYYYY
 password=XXXXXX
-host=microb98.med.upenn.edu
-port=3309
-database=intsitesdev
+host=microbZZZ.med.upenn.edu
+port=330X
+database=XXX
 ```
 
 # Dependencies
 
-intSiteRetriever : https://github.com/esherm/intSiteRetriever 
-(at present get the project in current folder:
-```
-git clone https://github.com/esherm/intSiteRetriever
-```)
+intSiteRetriever
 hiAnnotator
 pipeUtils
 colorspace
+GCcontent
 
-GCcontent: https://github.com/anatolydryga/GCcontent
+List of cancer genes are copied from:
+CancerGeneList
 
-# pipeUtils requirement
+# implementation details: pipeUtils requirement
 
 needs a column type which is hard-coded as "insertion" for integration site
 and "match" for match random contol(mrc).
 
+pipeUtils can only generate figures for 2 or more samples.
+