Skip to content

Commit

Permalink
minor improvements to README.md
Browse files Browse the repository at this point in the history
also improve wording in Dockerfile (see: nf-core/tools#451)
  • Loading branch information
phue committed Nov 13, 2019
1 parent a3d85fc commit 7f72a47
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down Expand Up @@ -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:

Expand Down

0 comments on commit 7f72a47

Please sign in to comment.