diff --git a/Dockerfile b/Dockerfile index 6ab33ec..f0aa42e 100644 --- a/Dockerfile +++ b/Dockerfile @@ -5,7 +5,7 @@ RUN apt install libcurl4-openssl-dev libssl-dev -y RUN pip3 install Cython numpy RUN apt install mash ncbi-blast+ bowtie2 seqtk samtools bcftools -y RUN git clone https://github.com/phac-nml/ecoli_serotyping.git -# install the tool and initilize its species ID MASH database +# install the tool and initialize its species ID MASH database RUN cd ecoli_serotyping && git checkout v2.0.0 && pip3 install . RUN ectyper_init diff --git a/README.md b/README.md index fd5ea29..1f20022 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ The tool provides convenient species identification coupled to quality control m As WGS becomes standard within public health and research laboratories, it is important to harness the high throughput and resolution potential of this technology providing accurate and rapid at scale typing of E.coli both in public health, clinical and research contexts. ## Citation -If you find `ectyper` useful, please cite the following paper: +If you find `ECTyper` useful, please cite the following paper: > Bessonov, Kyrylo, Chad Laing, James Robertson, Irene Yong, Kim Ziebell, Victor PJ Gannon, Anil Nichani, Gitanjali Arya, John HE Nash, and Sara Christianson. **"ECTyper: in silico Escherichia coli serotype and species prediction from raw and assembled whole-genome sequence data."** Microbial genomics 7, no. 12 (2021): 000728. [https://www.microbiologyresearch.org/content/journal/mgen/10.1099/mgen.0.000728](https://www.microbiologyresearch.org/content/journal/mgen/10.1099/mgen.0.000728) @@ -27,7 +27,7 @@ For any questions, issues or comments please make a Github issue or reach out to # Installation Multiple installation options are available depending on the user context and needs. The most convinient installation is as a `conda` package as it will install all required dependencies. -### Images availability +### Docker and Singularity images availability Docker and Singularity images are also available from [https://biocontainers.pro/tools/ectyper](https://biocontainers.pro/tools/ectyper) that could be useful for NextFlow or hassle-free deployment ### Databases @@ -72,10 +72,10 @@ Install python dependencies via `pip`: Clone the repository or checkout a particular release (e.g `v1.0.0`, `v2.0.0` etc.): ``` git clone https://github.com/phac-nml/ecoli_serotyping.git - git checkout v1.0.0 #optionally checkout a specific release version + git checkout v2.0.0 #optionally checkout a specific release version ``` -Finally, install ectyper +Finally, install ectyper from source ``` python3 setup.py install # option 1 pip3 install . # option 2 @@ -102,12 +102,12 @@ pip3 install . # option 2 1. View the results on the console or in `cat [output folder]/output.csv` ## Example Input Scenarios -* `ectyper -i ecoliA.fasta` for a single file (the output folder will be named using `ectyper__