diff --git a/README.html b/README.html new file mode 100644 index 000000000..fb417def0 --- /dev/null +++ b/README.html @@ -0,0 +1,443 @@ + + + + + + + + + + +
+ + +bcbio banner +

Validated, scalable, community developed variant calling and RNA-seq analysis. +You write a high level configuration file specifying your inputs and analysis +parameters. This input drives a parallel run that handles distributed +execution, idempotent processing restarts and safe transactional steps. +bcbio-nextgen provides a shared community resource that handles the data processing +component of sequencing analysis, providing researchers with more time to focus +on the downstream biology.

+
+

Features

+ +
+
+

Quick start

+
    +
  1. Install bcbio-nextgen with all tool dependencies and data files:

    +
    +wget https://raw.github.com/chapmanb/bcbio-nextgen/master/scripts/bcbio_nextgen_install.py
    +python bcbio_nextgen_install.py /usr/local/share/bcbio --tooldir=/usr/local \
    +  --genomes GRCh37 --aligners bwa --aligners bowtie2
    +
    +

    producing an editable system configuration file referencing the installed +software, data and system information.

    +
  2. +
  3. Automatically create a processing description of sample FASTQ and BAM files +from your project, and a CSV file of sample metadata:

    +
    +bcbio_nextgen.py -w template freebayes-variant project1.csv sample1.bam sample2_1.fq sample2_2.fq
    +
    +

    This produces a sample description file containing pipeline configuration options.

    +
  4. +
  5. Run analysis, distributed across 8 local cores:

    +
    +cd project1/work
    +bcbio_nextgen.py ../config/project1.yaml -n 8
    +
    +
  6. +
+
+
+

Documentation

+

See the full documentation at ReadTheDocs. We welcome enhancements +or problem reports using GitHub and discussion on the +biovalidation mailing list.

+
+
+

Contributors

+ +
+
+

License

+

The code is freely available under the MIT license.

+
+
+ + diff --git a/README.rst b/README.rst index 777df551f..54b5bac99 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,6 @@ -bcbio-nextgen -------------- +.. image:: artwork/github.png + :alt: bcbio banner + :align: center Validated, scalable, community developed variant calling and RNA-seq analysis. You write a high level configuration file specifying your inputs and analysis diff --git a/artwork/bcbio-nextgen.sketch b/artwork/bcbio-nextgen.sketch new file mode 100644 index 000000000..7cad14e5e Binary files /dev/null and b/artwork/bcbio-nextgen.sketch differ diff --git a/artwork/github.png b/artwork/github.png new file mode 100644 index 000000000..989fea6ab Binary files /dev/null and b/artwork/github.png differ diff --git a/artwork/logo.png b/artwork/logo.png new file mode 100644 index 000000000..1f269c4fc Binary files /dev/null and b/artwork/logo.png differ diff --git a/artwork/logo.svg b/artwork/logo.svg new file mode 100644 index 000000000..0fcd9fcde --- /dev/null +++ b/artwork/logo.svg @@ -0,0 +1,26 @@ + + + + logo + Created with Sketch. + + + + + \ No newline at end of file diff --git a/docs/contents/images/github.png b/docs/contents/images/github.png new file mode 120000 index 000000000..dffd174ac --- /dev/null +++ b/docs/contents/images/github.png @@ -0,0 +1 @@ +../../../artwork/github.png \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 41374f84e..d512d5020 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,8 +3,9 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -bcbio-nextgen -============= +.. image:: contents/images/github.png + :alt: bcbio banner + :align: center A python toolkit providing best-practice pipelines for fully automated high throughput sequencing analysis. You write a high level