-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9 from phac-nml/remove-nf-core-branding
Remove nf core branding
- Loading branch information
Showing
6 changed files
with
64 additions
and
86 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,106 +1,89 @@ | ||
| #   | ||
| [](https://www.nextflow.io/) | ||
|
|
||
| [](https://github.com/nf-core/staramr/actions?query=workflow%3A%22nf-core+CI%22) | ||
| [](https://github.com/nf-core/staramr/actions?query=workflow%3A%22nf-core+linting%22)[](https://nf-co.re/staramr/results)[](https://doi.org/10.5281/zenodo.XXXXXXX) | ||
|
|
||
| [](https://www.nextflow.io/) | ||
| [](https://docs.conda.io/en/latest/) | ||
| [](https://www.docker.com/) | ||
| [](https://sylabs.io/docs/) | ||
| [](https://tower.nf/launch?pipeline=https://github.com/nf-core/staramr) | ||
|
|
||
| [](https://nfcore.slack.com/channels/staramr)[](https://twitter.com/nf_core)[](https://mstdn.science/@nf_core)[](https://www.youtube.com/c/nf-core) | ||
| # `staramr`: nextflow pipeline | ||
|
|
||
| ## Introduction | ||
|
|
||
| **nf-core/staramr** is a bioinformatics pipeline that ... | ||
| **staramr: nextflow pipeline** is the nextflow adaptation of the [staramr](https://github.com/phac-nml/staramr/) | ||
|
|
||
| <!-- TODO nf-core: | ||
| Complete this sentence with a 2-3 sentence summary of what types of data the pipeline ingests, a brief overview of the | ||
| major pipeline sections and the types of output it produces. You're giving an overview to someone new | ||
| to nf-core here, in 15-20 seconds. For an example, see https://github.com/nf-core/rnaseq/blob/master/README.md#introduction | ||
| --> | ||
|
|
||
| <!-- TODO nf-core: Include a figure that guides the user through the major workflow steps. Many nf-core | ||
| workflows use the "tube map" design for that. See https://nf-co.re/docs/contributing/design_guidelines#examples for examples. --> | ||
| <!-- TODO nf-core: Fill in short bullet-pointed list of the default steps in the pipeline --> | ||
| > `staramr` (_AMR) scans bacterial genome contigs against the [ResFinder][resfinder-db], [PointFinder][pointfinder-db], and [PlasmidFinder][plasmidfinder-db] databases (used by the [ResFinder webservice][resfinder-web] and other webservices offered by the Center for Genomic Epidemiology) and compiles a summary report of detected antimicrobial resistance genes. The `star|_`in`staramr` indicates that it can handle all of the ResFinder, PointFinder, and PlasmidFinder databases. | ||
| ## Usage | ||
|
|
||
| :::note | ||
| If you are new to Nextflow and nf-core, please refer to [this page](https://nf-co.re/docs/usage/installation) on how | ||
| to set-up Nextflow. Make sure to [test your setup](https://nf-co.re/docs/usage/introduction#how-to-run-a-pipeline) | ||
| with `-profile test` before running the workflow on actual data. | ||
| ::: | ||
|
|
||
| <!-- TODO nf-core: Describe the minimum required steps to execute the pipeline, e.g. how to prepare samplesheets. | ||
| Explain what rows and columns represent. For instance (please edit as appropriate): | ||
|
|
||
| First, prepare a samplesheet with your input data that looks as follows: | ||
| `samplesheet.csv`: | ||
| ```csv | ||
| sample,fastq_1,fastq_2 | ||
| CONTROL_REP1,AEG588A1_S1_L002_R1_001.fastq.gz,AEG588A1_S1_L002_R2_001.fastq.gz | ||
| ```bash | ||
| nextflow run main.nf -profile test,docker --outdir ./results | ||
| ``` | ||
|
|
||
| Each row represents a fastq file (single-end) or a pair of fastq files (paired end). | ||
| ### Input | ||
|
|
||
| The input to the pipeline is a standard sample sheet (passed as `--input samplesheet.csv`) that looks like: | ||
|
|
||
| --> | ||
| | sample | contigs | species | | ||
| | ------- | ---------------- | ------------------- | | ||
| | SampleA | genomeA.fastq.gz | Salmonella enterica | | ||
|
|
||
| Now, you can run the pipeline using: | ||
| The structure of this file is defined in [assets/schema_input.json](assets/schema_input.json). Validation of the sample sheet is performed by [nf-validation](https://nextflow-io.github.io/nf-validation/). | ||
|
|
||
| <!-- TODO nf-core: update the following command to include all required parameters for a minimal example --> | ||
| ### Output | ||
|
|
||
| ```bash | ||
| nextflow run nf-core/staramr \ | ||
| -profile <docker/singularity/.../institute> \ | ||
| --input samplesheet.csv \ | ||
| --outdir <OUTDIR> | ||
| results/staramr/ | ||
| └── SampleA_results | ||
| ├── detailed_summary.tsv | ||
| ├── mlst.tsv | ||
| ├── plasmidfinder.tsv | ||
| ├── resfinder.tsv | ||
| ├── results.xlsx | ||
| ├── settings.txt | ||
| └── summary.tsv | ||
| ``` | ||
|
|
||
| :::warning | ||
| Please provide pipeline parameters via the CLI or Nextflow `-params-file` option. Custom config files including those | ||
| provided by the `-c` Nextflow option can be used to provide any configuration _**except for parameters**_; | ||
| see [docs](https://nf-co.re/usage/configuration#custom-configuration-files). | ||
| ::: | ||
| See the [staramr documentation](https://github.com/phac-nml/staramr/blob/development/README.md) for more details and explanations. | ||
|
|
||
| For more details and further functionality, please refer to the [usage documentation](https://nf-co.re/staramr/usage) and the [parameter documentation](https://nf-co.re/staramr/parameters). | ||
| ## Citation | ||
|
|
||
| ## Pipeline output | ||
| ### staramr | ||
|
|
||
| To see the results of an example test run with a full size dataset refer to the [results](https://nf-co.re/staramr/results) tab on the nf-core website pipeline page. | ||
| For more details about the output files and reports, please refer to the | ||
| [output documentation](https://nf-co.re/staramr/output). | ||
| > Bharat A, Petkau A, Avery BP, Chen JC, Folster JP, Carson CA, Kearney A, Nadon C, Mabon P, Thiessen J, Alexander DC, Allen V, El Bailey S, Bekal S, German GJ, Haldane D, Hoang L, Chui L, Minion J, Zahariadis G, Domselaar GV, Reid-Smith RJ, Mulvey MR. **Correlation between Phenotypic and In Silico Detection of Antimicrobial Resistance in Salmonella enterica in Canada Using Staramr**. Microorganisms. 2022; 10(2):292. https://doi.org/10.3390/microorganisms10020292 | ||
| ## Credits | ||
| ### Databases used by staramr | ||
|
|
||
| nf-core/staramr was originally written by Eric Marinier. | ||
| > **Zankari E, Hasman H, Cosentino S, Vestergaard M, Rasmussen S, Lund O, Aarestrup FM, Larsen MV**. 2012. Identification of acquired antimicrobial resistance genes. J. Antimicrob. Chemother. 67:2640–2644. doi: [10.1093/jac/dks261][resfinder-cite] | ||
| We thank the following people for their extensive assistance in the development of this pipeline: | ||
| > **Zankari E, Allesøe R, Joensen KG, Cavaco LM, Lund O, Aarestrup F**. PointFinder: a novel web tool for WGS-based detection of antimicrobial resistance associated with chromosomal point mutations in bacterial pathogens. J Antimicrob Chemother. 2017; 72(10): 2764–8. doi: [10.1093/jac/dkx217][pointfinder-cite] | ||
| <!-- TODO nf-core: If applicable, make list of people who have also contributed --> | ||
| > **Carattoli A, Zankari E, Garcia-Fernandez A, Voldby Larsen M, Lund O, Villa L, Aarestrup FM, Hasman H**. PlasmidFinder and pMLST: in silico detection and typing of plasmids. Antimicrob. Agents Chemother. 2014. April 28th. doi: [10.1128/AAC.02412-14][plasmidfinder-cite] | ||
| ## Contributions and Support | ||
| > **Seemann T**, MLST Github https://github.com/tseemann/mlst | ||
| If you would like to contribute to this pipeline, please see the [contributing guidelines](.github/CONTRIBUTING.md). | ||
| > **Jolley KA, Bray JE and Maiden MCJ**. Open-access bacterial population genomics: BIGSdb software, the PubMLST.org website and their applications [version 1; peer review: 2 approved]. Wellcome Open Res 2018, 3:124. doi: [10.12688/wellcomeopenres.14826.1][mlst-cite] | ||
| For further information or help, don't hesitate to get in touch on the [Slack `#staramr` channel](https://nfcore.slack.com/channels/staramr) (you can join with [this invite](https://nf-co.re/join/slack)). | ||
| ### nf-core | ||
|
|
||
| ## Citations | ||
| This pipeline uses code and infrastructure developed and maintained by the [nf-core](https://nf-co.re) community, reused here under the [MIT license](https://github.com/nf-core/tools/blob/master/LICENSE). | ||
|
|
||
| <!-- TODO nf-core: Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file. --> | ||
| <!-- If you use nf-core/staramr for your analysis, please cite it using the following doi: [10.5281/zenodo.XXXXXX](https://doi.org/10.5281/zenodo.XXXXXX) --> | ||
| > The nf-core framework for community-curated bioinformatics pipelines. | ||
| > | ||
| > Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen. | ||
| > | ||
| > Nat Biotechnol. 2020 Feb 13. doi: 10.1038/s41587-020-0439-x. | ||
| > In addition, references of tools and data used in this pipeline are as follows: | ||
| <!-- TODO nf-core: Add bibliography of tools and data used in your pipeline --> | ||
| ## Legal | ||
|
|
||
| An extensive list of references for the tools used by the pipeline can be found in the [`CITATIONS.md`](CITATIONS.md) file. | ||
| Copyright 2024 Government of Canada | ||
|
|
||
| You can cite the `nf-core` publication as follows: | ||
| Licensed under the MIT License (the "License"); you may not use | ||
| this work except in compliance with the License. You may obtain a copy of the | ||
| License at: | ||
|
|
||
| > **The nf-core framework for community-curated bioinformatics pipelines.** | ||
| > | ||
| > Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen. | ||
| > | ||
| > _Nat Biotechnol._ 2020 Feb 13. doi: [10.1038/s41587-020-0439-x](https://dx.doi.org/10.1038/s41587-020-0439-x). | ||
| https://opensource.org/license/mit/ | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software distributed | ||
| under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR | ||
| CONDITIONS OF ANY KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations under the License. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters