From 7f72a4721a9d16084b50d26ec9cec68931432378 Mon Sep 17 00:00:00 2001 From: phue Date: Wed, 13 Nov 2019 08:34:03 +0100 Subject: [PATCH] minor improvements to README.md also improve wording in Dockerfile (see: https://github.com/nf-core/tools/pull/451) --- Dockerfile | 2 +- README.md | 6 +----- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/Dockerfile b/Dockerfile index acb6c5d7..59c6ceb4 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,6 +1,6 @@ FROM nfcore/base:1.7 LABEL authors="Phil Ewels" \ - description="Docker image containing all requirements for nf-core/methylseq pipeline" + description="Docker image containing all software requirements for the nf-core/methylseq pipeline" COPY environment.yml / RUN conda env create -f /environment.yml && conda clean -a diff --git a/README.md b/README.md index 0f23cda5..7bc749ab 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,8 @@ The pipeline uses [Nextflow](https://www.nextflow.io), a bioinformatics workflow tool. It pre-processes raw data from FastQ inputs, aligns the reads and performs extensive quality-control on the results. -## Introduction - The pipeline is built using [Nextflow](https://www.nextflow.io), a workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It comes with docker containers making installation trivial and results highly reproducible. -## Pipeline Summary - The pipeline allows you to choose between running either [Bismark](https://github.com/FelixKrueger/Bismark) or [bwa-meth](https://github.com/brentp/bwa-meth) / [MethylDackel](https://github.com/dpryan79/methyldackel). Choose between workflows by using `--aligner bismark` (default, uses bowtie2 for alignment), `--aligner bismark_hisat` or `--aligner bwameth`. @@ -89,7 +85,7 @@ For further information or help, don't hesitate to get in touch on [Slack](https ## Citation -If you use nf-core/methylseq for your analysis, please cite it using the following doi: [10.5281/zenodo.2555454](https://doi.org/10.5281/zenodo.2555454) --> +If you use nf-core/methylseq for your analysis, please cite it using the following doi: [10.5281/zenodo.2555454](https://doi.org/10.5281/zenodo.2555454) You can cite the `nf-core` pre-print as follows: