Skip to content

Commit 8844c8d

Browse files
authored
Update README.md
1 parent aa8c097 commit 8844c8d

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ properseqTools -a /path/to/read1.fastq
6666

6767
**Required parameters**
6868
<pre><code>
69-
-a |String, Path to read1 fastq file
70-
-b |String, Path to read2 fastq file
69+
-a |String, Path to read1 fastq file, fastq.gz also supported
70+
-b |String, Path to read2 fastq file, fastq.gz also supported
7171
-o |String, Path to output directory
7272
-i |String, Path to bwa index of the target transcriptome
7373
-g |String, Path to transcirpt, gene and gene type dictionary file
@@ -77,6 +77,7 @@ properseqTools -a /path/to/read1.fastq
7777
-d |Float, odds ratio cutoff used to identify protein-protein interactions, default=1
7878
-p |Float, false discovery rate cutoff used to identify protein-protein interactions, default=0.05
7979
-c |Float, read count cutoff coefficient used to identify protein-protein interactions, default=4
80+
-j |String, Job ID to be prepended to the output files and directories, optional, default=PROPERseq"
8081
-t |Int, Number of working threads, default=2
8182
-r |Char, (T or F), removal of intermediate files or not, default=T
8283
-h |Print usage message"
@@ -91,7 +92,8 @@ chimericReadPairs.csv |a file that contains the read ids of the iden
9192
summary.csv |a file that contains the summary statistics of running the sample with PROPERseqTools
9293
errorLog.txt |a file that contains error message from the pipeline if any
9394
processedFastq/ |a directory that contains the pre-processed fastq files from the sample
94-
alignment/ |a directory that contains the alignment files of the pre-processed fastq files from the sample
95+
alignment/mappedReadPairs.csv |a file that contains the alignment infomation of all mapped read pairs from the sample
96+
alignment/*/ |subdirectories that contain the alignment files of the pre-processed fastq files from the sample
9597
intermediateFiles/ |an optional directory contains all the intermediat files generated from running the pipeline, this direcotry only exists if '-r' option is set to 'F'
9698

9799
</code></pre>

0 commit comments

Comments
 (0)