i. Install [`nextflow`](https://nf-co.re/usage/installation)
ii. Install either [`Docker`](https://docs.docker.com/engine/installation/) or [`Singularity`](https://www.sylabs.io/guides/3.0/user-guide/) for full pipeline reproducibility (please only use [`Conda`](https://conda.io/miniconda.html) as a last resort; see [docs](https://nf-co.re/usage/configuration#basic-configuration-profiles))
ii. Install either [`Docker`](https://docs.docker.com/engine/installation/)
or [`Singularity`](https://www.sylabs.io/guides/3.0/user-guide/)
for full pipeline reproducibility (please only use [`Conda`](https://conda.io/miniconda.html)
as a last resort; see [docs](https://nf-co.re/usage/configuration#basic-configuration-profiles))
iii. Download the pipeline and test it on a minimal dataset with a single command
...
...
@@ -51,7 +54,11 @@ iii. Download the pipeline and test it on a minimal dataset with a single comman
nextflow run nf-core/hic -profiletest,<docker/singularity/conda/institute>
```
> Please check [nf-core/configs](https://github.com/nf-core/configs#documentation) to see if a custom config file to run nf-core pipelines already exists for your Institute. If so, you can simply use `-profile <institute>` in your command. This will enable either `docker` or `singularity` and set the appropriate execution settings for your local compute environment.
@@ -86,7 +94,9 @@ nf-core/hic was originally written by Nicolas Servant.
If you would like to contribute to this pipeline, please see the [contributing guidelines](.github/CONTRIBUTING.md).
For further information or help, don't hesitate to get in touch on [Slack](https://nfcore.slack.com/channels/hic)(you can join with [this invite](https://nf-co.re/join/slack)).
For further information or help, don't hesitate to get in touch on
[Slack](https://nfcore.slack.com/channels/hic)(you can join with
[this invite](https://nf-co.re/join/slack)).
## Citation
...
...
@@ -97,7 +107,9 @@ You can cite the `nf-core` publication as follows:
> **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.
> 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).