You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+8-3Lines changed: 8 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -101,6 +101,12 @@ Documentation about OLOGRAM (OverLap Of Genomic Regions Analysis using Monte Car
101
101
102
102
**NB:** The readthedoc version won't be maintained and will be closed in the near future. This choice was motivated by the impossibility to maintain a dynamic documentation (using sphinx/sphinxcontrib-programoutput) given the computing time provided by readthedoc server.
103
103
104
+
Note that example dataset are available to test the various subcommands (see `documentation page <https://dputhier.github.io/pygtftk/information.html#get-example>`_).
105
+
106
+
gtftk get_example -h
107
+
# E.g. to get all file from the 'simple' dataset
108
+
gtftk get_example -d simple -f "*"
109
+
104
110
105
111
System requirements
106
112
--------------------
@@ -112,14 +118,13 @@ At the moment, the gtftk program has been tested on:
112
118
- Linux (Ubuntu 12.04 and 18.04)
113
119
- OSX (Yosemite, El Capitan, Mojave).
114
120
115
-
116
121
Installation
117
122
-------------
118
123
119
124
Installation through conda package building
120
125
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
121
126
122
-
Installation through **conda** should be the **preferred install solution**. The pygtftk package and gtftk command line tool require external dependencies with some version constrains.
127
+
Installation through **conda** should be the **preferred install solution**. The pygtftk package and gtftk command line tool require external dependencies (bedtools ">v2.23.1", graphviz, unzip) with some version constrains.
123
128
124
129
If conda is not available on your system, first install miniconda from the official `web site <http://conda.pydata.org/miniconda.html>`_ and make sure you have bioconda and conda-forge channels set up in the order below. ::
125
130
@@ -140,7 +145,7 @@ This is not the preferred way for installation. Choose conda whenever possible.
0 commit comments