Skip to content

Commit

Permalink
Update UseCases.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
BaumgartenNina committed Apr 23, 2020
1 parent 5c1907b commit 0bde1e3
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion docs/UseCases.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Query Guide
---------
Here we provide a step-by-step guide for every query available, including an explanation of the output. Every query has an *Example Query* button at the bottom of the page. Try it out to see how a valid query would look like. Have a look at :ref:`Results in detail` to get an explanation of all the output parameters. In addition, we provide an example file for each possible file upload in the Supplemenary of our paper (currently under revision).
Here we provide a step-by-step guide for every query available, including an explanation of the output. Every query has an *Example Query* button at the bottom of the page. Try it out to see how a valid query would look like. Have a look at :ref:`Results in detail` to get an explanation of all the output parameters. In addition, we provide an example file for each possible file upload, see :ref:`Examples file upload`.

Gene Query
=================
Expand Down Expand Up @@ -117,6 +117,21 @@ All result tables possess additional functionalities like the possibility to fil
:alt: gProfiler limit
:width: 400

Examples file upload
=================
It is also possible to upload a csv-, txt- or bed-file for the different queries. A combination of both, input field and uploaded file, is not implemented. All of the commonly used separators are being recognized, however files with empty fields will not be read correctly.
For the region query it is important that the order of chromosome, start position and end position is correct. If a bed-file is provided for the this query, the columns have to be in the order chromsome, start position and end position as well. All additional columns beside of those first three ones will be ignored.

In the following you can download an example for each query:

.. hlist::
:columns: 1

* :download:`Gene query <doc/ExampleFile_GeneQuery>`
* :download:`Region query <doc/ExampleFile_RegionQuery>`
* :download:`REM query <doc/ExampleFile_REMQuery>`


Available cell and tissue types
=================
In case you are wondering, whether your cell type or tissue is availale on EpiRegio, we list the available ones here. Every name is written as you would find it in the field where you filter for cell types (without the bullet point of course).
Expand Down

0 comments on commit 0bde1e3

Please sign in to comment.