Skip to content

Commit

Permalink
Improved documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Ad115 committed Sep 3, 2018
1 parent 7eb1d23 commit 4158f66
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,12 @@ A library to ease the parsing of data from the International Cancer Genome
Consortium data releases, in particular, the simple somatic mutation
aggregates.



Tutorial
========

Installation
============
------------

Install via `PyPI <https://pypi.org/project/ICGC-data-parser/>`__:

Expand All @@ -23,7 +26,7 @@ Install via `PyPI <https://pypi.org/project/ICGC-data-parser/>`__:

Data download
=============
-------------

The base data for the scripts is the ICGC's aggregated of the simple
somatic mutation data. Which can be downloded using
Expand Down Expand Up @@ -64,8 +67,8 @@ In the future this will be solved in a more elegant way, but for
now this is what we've got.


Tutorial
========
Usage
-----

The main class in the project is the ``SSM_Reader``. It allows to read
easily the ICGC mutations file:
Expand Down Expand Up @@ -210,7 +213,7 @@ Meta
a.garcia230395@gmail.com


**Pages**:
**Project pages**:
`Docs <https://icgc-data-parser.readthedocs.io>`__ - `@GitHub <https://github.com/Ad115/ICGC-data-parser/>`__ - `@PyPI <https://pypi.org/project/ICGC-data-parser/>`__

Distributed under the MIT license. See
Expand Down

0 comments on commit 4158f66

Please sign in to comment.