Skip to content

Commit 98e8271

Browse files
Merge pull request #1 from Zymo-Research/readmeAddPaperAndLinebreaks
Add paper link and line breaks to quickstart
2 parents 4e06276 + 110598f commit 98e8271

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*The beauty of science is to make things simple*. It in this spirit that we developed and present to you FIGARO: An efficient and objective tool for optimizing microbiome rRNA gene trimming parameters. FIGARO will quickly analyze error rates in a directory of FASTQ files to determine optimal trimming parameters for high-resolution targeted microbiome sequencing pipelines, such as those utilizing [DADA2](https://github.com/benjjneb/dada2 "Github") and [Deblur](https://github.com/biocore/deblur "Github"). The mission of this application is identical to the [ZymoBIOMICS](https://www.zymoresearch.com/pages/zymobiomics-portfolio) mission: increasing the reproducibility and standardization of microbiome analysis.
44

55
#### Publication
6-
Please see [FIGARO: An efficient and objective tool for optimizing microbiome rRNA gene trimming parameters](link/to/preprint/here "Preprint version")
6+
Please see [FIGARO: An efficient and objective tool for optimizing microbiome rRNA gene trimming parameters](https://www.biorxiv.org/content/10.1101/610394v1 "Preprint version")
77

88
## Quick Start Guide
99

@@ -12,15 +12,18 @@ Please see [FIGARO: An efficient and objective tool for optimizing microbiome rR
1212
git clone https://github.com/Zymo-Research/figaro.git
1313
cd figaro
1414
docker build -t figaro .
15-
docker container run --rm -e AMPLICONLENGTH=[amplicon length] -e FORWARDPRIMERLENGTH=[forward primer length] -e REVERSEPRIMERLENGTH=[reverse primer length] -v /path/to/fastqs:/data/input -v /path/to/output:/data/output figaro
15+
docker container run --rm -e AMPLICONLENGTH=[amplicon length] -e FORWARDPRIMERLENGTH=[forward primer length] \
16+
-e REVERSEPRIMERLENGTH=[reverse primer length] -v /path/to/fastqs:/data/input \
17+
-v /path/to/output:/data/output figaro
1618
```
1719

1820
#### Command line
1921
```
2022
git clone https://github.com/Zymo-Research/figaro.git
2123
cd figaro
2224
pip3 install -r requirements.txt
23-
python3 figaro.py -i /path/to/fastq/directory -o /path/to/output/files -a [amplicon length] -f [forward primer length] -r [reverse primer length]
25+
python3 figaro.py -i /path/to/fastq/directory -o /path/to/output/files -a [amplicon length] \
26+
-f [forward primer length] -r [reverse primer length]
2427
```
2528

2629
## Getting Started
@@ -196,4 +199,4 @@ We would like to thank the following, without whom this would not have happened:
196199
---------------------------------------------------------------------------------------------------------------------
197200

198201
#### If you like this software, please let us know at [email protected].
199-
#### Please support our continued development of free and open-source microbiomics applications by checking out the latest microbiomics offerings from [ZymoBIOMICS](https://www.zymoresearch.com/pages/zymobiomics-portfolio)
202+
#### Please support our continued development of free and open-source microbiomics applications by checking out the latest microbiomics offerings from [ZymoBIOMICS](https://www.zymoresearch.com/pages/zymobiomics-portfolio)

0 commit comments

Comments
 (0)