@@ -9,13 +9,13 @@ SYSTEM REQUIREMENTS:
99========================================================================
1010The preseq software will only run on 64-bit UNIX-like operating
1111systems and was developed on both Linux and Mac. The preseq software
12- requires a C++ compiler that supports C++11.
12+ requires a C++ compiler that supports C++11.
1313
1414INSTALLATION:
1515========================================================================
1616### Installing from a release
1717
18- 1 . Download preseq-x.tar.gz from the releases tab of this repository.
18+ 1 . Download ` preseq-x.tar.gz ` from the releases tab of this repository.
19192 . Unpack the archive:
2020```
2121$ tar -zxvf preseq-x.tar.gz
@@ -89,23 +89,23 @@ USAGE EXAMPLES:
8989Each program included in this software package will print a list of
9090options if executed without any command line arguments. Many of the
9191programs use similar options (for example, output files are specified
92- with '-o').
92+ with '-o').
9393
9494We have provided a data directory to test each of our programs.
95- Change to the ` data ` directory and try some of our commands.
95+ Change to the ` data ` directory and try some of our commands.
9696To predict the yield of a future experiment, use ` lc_extrap ` .
97- For the most basic usage of ` lc_extrap ` to compute the expected yield,
97+ For the most basic usage of ` lc_extrap ` to compute the expected yield,
9898use the command on the following data:
9999```
100- preseq lc_extrap -o yield_estimates.txt SRR1003759_5M_subset.mr
100+ preseq lc_extrap -o yield_estimates.txt SRR1003759_5M_subset.mr
101101```
102102If the input file is in ` .bam ` format, use the ` -B ` flag:
103103```
104104preseq lc_extrap -B -o yield_estimates.txt SRR1106616_5M_subset.bam
105105```
106106For the counts histogram format, use the ` -H ` flag:
107107```
108- preseq lc_extrap -H -o yield_estimates.txt SRR1301329_1M_read.txt
108+ preseq lc_extrap -H -o yield_estimates.txt SRR1301329_1M_read.txt
109109```
110110
111111The yield estimates will appear in yield_estimates.txt, and will be a
@@ -115,33 +115,33 @@ by two columns giving the corresponding confidence intervals.
115115
116116To investigate the past yield of an experiment, use ` c_curve ` .
117117` c_curve ` can take in the same file formats as ` lc_extrap ` by using
118- the same flags. The estimates will appear in estimates.txt with two
119- columns. The first column gives the total number of reads in a
120- theoretically smaller experiment and the second gives the corresponding
121- number of distinct reads.
118+ the same flags. The estimates will appear in estimates.txt with two
119+ columns. The first column gives the total number of reads in a
120+ theoretically smaller experiment and the second gives the
121+ corresponding number of distinct reads.
122122
123- ` bound_pop ` provides an estimate for the species richness
124- of the sampled population. The input file formats and corresponding flags
125- are identical to ` c_curve ` and ` lc_extrap ` . The output provides the median
126- species richness in the first column and the confidence intervals
127- in the next two columns.
128-
129- Finally, ` gc_extrap ` predicts the expected genomic coverage for a future experiment.
130- It produces the coverage in an output format identical to ` lc_extrap ` . ` gc_extrap `
131- can only take in files in BED and mapped reads format (using the ` -B ` flag for BED):
123+ ` bound_pop ` provides an estimate for the species richness of the
124+ sampled population. The input file formats and corresponding flags are
125+ identical to ` c_curve ` and ` lc_extrap ` . The output provides the median
126+ species richness in the first column and the confidence intervals in
127+ the next two columns.
132128
129+ Finally, ` gc_extrap ` predicts the expected genomic coverage for a
130+ future experiment. It produces the coverage in an output format
131+ identical to ` lc_extrap ` . ` gc_extrap ` can only take in files in BED
132+ and mapped reads format (using the ` -B ` flag for BED):
133133```
134- preseq gc_extrap -B -o coverage_estimates.txt SRR1003759_5M_subset.mr
134+ preseq gc_extrap -B -o coverage_estimates.txt SRR1003759_5M_subset.mr
135135```
136136
137- More data is available in the ` additional_data.txt ` file in the ` data ` directory.
138- For an extended write-up on our programs, please read the manual in the ` docs `
139- directory.
137+ More data is available in the ` additional_data.txt ` file in the ` data `
138+ directory. For an extended write-up on our programs, please read the
139+ manual in the ` docs ` directory.
140140
141141UPDATES TO VERSION 3.0.2
142142========================================================================
143- GSL has been completely removed, and a data directory has been added for
144- users to test our programs.
143+ GSL has been completely removed, and a data directory has been added
144+ for users to test our programs.
145145
146146UPDATES TO VERSION 3.0.1
147147========================================================================
0 commit comments