Merge branch '17-documentation' into 'develop'

Resolve "Update Documentation"

Closes #17

See merge request !31

README.md

+|*master*|*develop*|
+|:-:|:-:|
+|[![Build Status](https://git.biohpc.swmed.edu/BICF/Astrocyte/cellranger_count/badges/master/build.svg)](https://git.biohpc.swmed.edu/BICF/Astrocyte/cellranger_count/commits/master)|[![Build Status](https://git.biohpc.swmed.edu/BICF/Astrocyte/cellranger_count/badges/develop/build.svg)](https://git.biohpc.swmed.edu/BICF/Astrocyte/cellranger_count/commits/develop)|
+
 10x Genomics scRNA-Seq (cellranger) count Pipeline
-========================================
+==================================================
 
 Introduction
 ------------
@@ -92,4 +96,4 @@ To Run:
 |---------|------------------------------------|------------------------------------|
 | sample1 | pbmc_1k_v2_S1_L001_R1_001.fastq.gz | pbmc_1k_v2_S1_L001_R2_001.fastq.gz |
 | sample2 | pbmc_1k_v2_S2_L001_R1_001.fastq.gz | pbmc_1k_v2_S2_L001_R2_001.fastq.gz |
-| sample2 | pbmc_1k_v2_S2_L002_R1_001.fastq.gz | pbmc_1k_v2_S2_L002_R2_001.fastq.gz |
+| sample2 | pbmc_1k_v2_S2_L002_R1_001.fastq.gz | pbmc_1k_v2_S2_L002_R2_001.fastq.gz |
\ No newline at end of file

docs/index.md

 10x Genomics scRNA-Seq (cellranger) count Pipeline
-========================================
+==================================================
 
 Introduction
 ------------
@@ -24,7 +24,7 @@ To Run:
         * column 3 = "fastq_R2"
         * can have repeated "Sample" if there are multiole fastq R1/R2 pairs for the samples
         * eg: can be downloaded [HERE](https://git.biohpc.swmed.edu/BICF/Astrocyte/cellranger_count/blob/8db3e25c13cb1463c2a50e510159c72380ae5826/docs/design.csv)
-    * **genome**
+  * **genome**
         * Reference species and genome used for alignment and subsequent analysis.
         * name of available 10x Gemomics premade reference genomes:
             * *'GRCh38-3.0.0'* = Human GRCh38 release 93
@@ -36,30 +36,39 @@ To Run:
             * *'hg19_and_mm10-3.0.0'* = Human GRCh37 (hg19) + Mouse GRCm38 (mm19) release 93
             * *'hg19_and_mm10-1.2.0'* = Human GRCh37 (hg19) + Mouse GRCm38 (mm19) release 84
             * *'ercc92-1.2.0'* = ERCC.92 Spike-In
-    * **expect cells**
+  * **expect cells**
         * Expected number of recovered cells.
         * guides cellranger in it's cutoff for background/low quality cells
         * as a guide it doesn't have to be exact
         * 0-10000
         * if --expextedCells is used then --forceCells is not necessary
         * only used if force cells is not entered or set to 0
-    * **force cells**
+   * **force cells**
         * Force pipeline to use this number of cells, bypassing the cell detection algorithm. Use this if the number of cells estimated by Cell Ranger is not consistent with the barcode rank plot. A value of 0 ignores this option. Any value other than 0 overrides expect-cells.
         * 0-10000
         * if force cells is used then expected cells is not necessary and is ignored
-    * **chemistry version**
+  * **chemistry version**
         * 10x single cell gene expression chemistry version (only used in cellranger version 3.x).
         * setting to auto will attempt to autodetect from the detected cycle strategy in the fastq's
         * chemistry version is only used if cellranger version is > 2.x
         * cellranger version 2.1.1 can only read chemistry version less than or equal to two (2)
-    * **cellranger version**
+   * **cellranger version**
         * 10x cellranger version.
         * cellranger version 2.1.1 can only read chemistry version less than or equal to two (2)
 
 * Design example:
 
-| Sample  | fastq_R1                           | fastq_R2                           |
-|---------|------------------------------------|------------------------------------|
-| sample1 | pbmc_1k_v2_S1_L001_R1_001.fastq.gz | pbmc_1k_v2_S1_L001_R2_001.fastq.gz |
-| sample2 | pbmc_1k_v2_S2_L001_R1_001.fastq.gz | pbmc_1k_v2_S2_L001_R2_001.fastq.gz |
-| sample2 | pbmc_1k_v2_S2_L002_R1_001.fastq.gz | pbmc_1k_v2_S2_L002_R2_001.fastq.gz |
+    | Sample  | fastq_R1                           | fastq_R2                           |
+    |---------|------------------------------------|------------------------------------|
+    | sample1 | pbmc_1k_v2_S1_L001_R1_001.fastq.gz | pbmc_1k_v2_S1_L001_R2_001.fastq.gz |
+    | sample2 | pbmc_1k_v2_S2_L001_R1_001.fastq.gz | pbmc_1k_v2_S2_L001_R2_001.fastq.gz |
+    | sample2 | pbmc_1k_v2_S2_L002_R1_001.fastq.gz | pbmc_1k_v2_S2_L002_R2_001.fastq.gz |
+    
+
+
+Credits
+-------
+This worklow is was developed jointly with the [Bioinformatic Core Facility (BICF), Department of Bioinformatics](http://www.utsouthwestern.edu/labs/bioinformatics/)
+
+
+Please cite in publications: Pipeline was developed by BICF from funding provided by **Cancer Prevention and Research Institute of Texas (RP150596)**.