Changes

From Genome Analysis Wiki
Jump to navigationJump to search
427 bytes removed ,  11:40, 16 March 2016
Line 4: Line 4:     
== Get geneZoom Source Codes ==
 
== Get geneZoom Source Codes ==
  −
=== Download from webpage ===
  −
Through this link [http://www.sph.umich.edu/csg/jich/geneZoom/  geneZoom Download], you can download a copy of geneZoom.
      
=== Download from GitHub with Git ===
 
=== Download from GitHub with Git ===
Line 40: Line 37:     
After you unzip, you can find 3 directories in "geneZoom" (./example  ./lib  ./scripts ./ref).
 
After you unzip, you can find 3 directories in "geneZoom" (./example  ./lib  ./scripts ./ref).
      
== Basic Usage Example ==
 
== Basic Usage Example ==
Line 79: Line 75:     
== Parameters ==
 
== Parameters ==
vcf: The VCF file has SNP information. This VCF must have header with sample ID.
+
'''vcf''': The VCF file has SNP information. This VCF must have header with sample ID. It can be a gz file or ASCII file.
 
  −
gene: The gene region will be plotted. For example, "PCSK9".
     −
phenotypeFile: The phenotype has phenotype value and sample ID. This file must have header to spcify which colum is phenotype value and sample ID.
+
'''gene''': The gene region will be plotted. For example, "PCSK9".
   −
sampleFieldName: The field name of sample ID in the phenotype file.
+
'''phenotypeFile''': The phenotype has phenotype value and sample ID. This file must have header to spcify which colum is phenotype value and sample ID.
   −
phenotypeFieldName: The field name of phenotype value in the phenotype file
+
'''sampleFieldName''': The field name of sample ID in the phenotype file.
   −
phenotypeDelim: The delim in phenotype file. It can be tab, blank or comma.
+
'''phenotypeFieldName''': The field name of phenotype value in the phenotype file
   −
snpList: SNP list which you want to show in plot. If you have a lot SNPs
+
'''phenotypeDelim''': The delim in phenotype file. It can be tab, blank or comma.
            in the gene region, you can specify the SNPs only shown in the
  −
            plot. Can be NULL.
     −
    snpChrFieldName
+
'''snpList''': SNP list which you want to show in plot. If you have a lot SNPs in the gene region, you can specify the SNPs only shown in the plot. Can be NULL.
            The field name of CHR in SNP list. If you don't define snpList,
  −
            this Can be NULL.
     −
    snpPosFieldName
+
'''snpChrFieldName''': The field name of CHR in SNP list. If you don't define snpList, this Can be NULL.
            The field name of POS in SNP list. If you don't define snpList,
  −
            this Can be NULL.
     −
    snpChrPosFieldName
+
'''snpPosFieldName''': The field name of POS in SNP list. If you don't define snpList, this Can be NULL.
            The field name of CHR:POS in SNP list. If you don't define
  −
            snpList, this Can be NULL.
     −
    snpDelim
+
'''snpChrPosFieldName''': The field name of CHR:POS in SNP list. If you don't define snpList, this Can be NULL.
            The delim in snp list. It can be tab, blank or comma. If you
  −
            don't define snpList, this Can be NULL.
     −
    lableSNPs
+
'''snpDelim''': The delim in snp list. It can be tab, blank or comma. If you don't define snpList, this Can be NULL.
            The SNP which will be labled in plot. Can be NULL.
     −
    flags  The annotation values, MAF range and colors. For example,
+
'''lableSNPs''': The SNP which will be labled in plot. Can be NULL.
            splicing:0:0.01:red,readthrough:blue. You must specify
  −
            annotation value,MAF range and color can be empty. The tool will
  −
            use the default MAF range(0,0.5), and random select one color.
     −
    defaultIntron
+
'''flags''': The annotation values, MAF range and colors. For example,splicing:0:0.01:red,readthrough:blue. You must specify annotation value,MAF range and color can be empty. The tool will use the default MAF range(0,0.5), and random select one color.
            The default intron lenght in plot. When draw enxon region, tool
  −
            re-define the intron region with this value. Can be NULL.
     −
    title  The titile of the plot. Can be NULL.
+
'''defaultIntron''': The default intron lenght in plot. When draw enxon region, tool re-define the intron region with this value. Can be NULL.
   −
    xlab    The xlab of the plot. Can be NULL.
+
'''title''': The titile of the plot. Can be NULL.
   −
    ylab    The xlab of the plot. Can be NULL.
+
'''xlab''': The xlab of the plot. Can be NULL.
   −
    titleCex
+
'''ylab''': The xlab of the plot. Can be NULL.
            The cex of title. This value can change the size of title. Can
  −
            be NULL.
     −
    xlabCex The cex of xlab. This value can change the size of xlab. Can be
+
'''titleCex''': The cex of title. This value can change the size of title. Can be NULL.
            NULL.
     −
    ylabCex The cex of ylab. This value can change the size of ylab. Can be
+
'''xlabCex''': The cex of xlab. This value can change the size of xlab. Can be NULL.
            NULL.
     −
    scatterYAxisCex
+
'''ylabCex''': The cex of ylab. This value can change the size of ylab. Can be NULL.
            The cex of y axis. This value can change the size of y axis. Can
  −
            be NULL.
     −
    phenotyeMeanLineColor
+
'''scatterYAxisCex''': The cex of y axis. This value can change the size of y axis. Can be NULL.
            The color of mean value of all SNPs in gene region. Can be NULL.
     −
    phenotyeMeanLineType
+
'''phenotyeMeanLineColor''': The color of mean value of all SNPs in gene region. Can be NULL.
            The line type of mean value of all SNPs in gene region. Can be
  −
            NULL.
     −
    phenotyeSDLineColor
+
'''phenotyeMeanLineType''': The line type of mean value of all SNPs in gene region. Can be NULL.
            The color of standard deviation value of all SNPs in gene
  −
            region. Can be NULL.
     −
    phenotyeSDLineType
+
'''phenotyeSDLineColor''': The color of standard deviation value of all SNPs in gene region. Can be NULL.
            The line type of standard deviation value of all SNPs in gene
  −
            region. Can be NULL.
     −
    exonRegionColor
+
'''phenotyeSDLineType''': The line type of standard deviation value of all SNPs in gene region. Can be NULL.
            The color of exon region. Can be NULL.
     −
    beanPlotXAxisLabelAngle
+
'''exonRegionColor''': The color of exon region. Can be NULL.
            The lable angle of bean plot x axis. Can be NULL.
     −
    beanPlotXAxisLableCex
+
'''beanPlotXAxisLabelAngle''': The lable angle of bean plot x axis. Can be NULL.
            The cex of bean plot x axis. Can be NULL.
     −
    beanPlotXAxisLablePos1
+
'''beanPlotXAxisLableCex''': The cex of bean plot x axis. Can be NULL.
            The position 1 of bean plot x axis lable. Can be NULL.
     −
    beanPlotXAxisLablePos2
+
'''beanPlotXAxisLablePos1''': The position 1 of bean plot x axis lable. Can be NULL.
            The position 2 of bean plot x axis lable. Can be NULL.
     −
    width  The width of plot. Default is 14.1 . Can be NULL.
+
'''beanPlotXAxisLablePos2''': The position 2 of bean plot x axis lable. Can be NULL.
   −
    height  The height of plot. Default is 10. Can be NULL.
+
'''width''': The width of plot. Default is 14.1 . Can be NULL.
   −
    format  The format of plot. It can be pdf,tiff and png. Can be NULL.
+
'''height''': The height of plot. Default is 10. Can be NULL.
   −
    outDIR  The result directory. All intermediate files and result plot
+
'''format''': The format of plot. It can be pdf,tiff and png. Can be NULL.
            file are in this folder.
      +
'''outDIR''': The result directory. All intermediate files and result plot file are in this folder.
    
== Testing geneZoom ==
 
== Testing geneZoom ==
Line 192: Line 152:     
== Acknowledgements  ==
 
== Acknowledgements  ==
geneZoom is the result of collaborative efforts by Cristen Willer, Jin Chen, He zhang, Ellen Schmidt, Wei Zhou, and Goncalo Abecasis. Please email Cristen Willer [cristen@umich.edu] with any questions.
+
'''geneZoom''' is the result of collaborative efforts by Cristen Willer, Jin Chen, He zhang, Ellen Schmidt, Wei Zhou, and Goncalo Abecasis. Please email Cristen Willer [cristen@umich.edu] with any questions.
96

edits

Navigation menu