Skip to content

Commit

Permalink
edit
Browse files Browse the repository at this point in the history
  • Loading branch information
ploy-np committed Dec 4, 2020
1 parent c7a3fdc commit 9a3da21
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 15 deletions.
1 change: 0 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ Contents
configuration
preparation
scripts
api

Contacts
--------
Expand Down
26 changes: 12 additions & 14 deletions docs/source/scripts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ Scripts

We provide 2 main scripts to run the analysis of differential RNA modifications as the following.

1. ``xpore-dataprep``
``xpore-dataprep``
********************

* Input

Input
******
Output files from `nanopolish eventalgin`. Please refer to :ref:`Data preparation <preparation>` for the full Nanopolish command.

Usage example
***************
* Usage example

====================== ========== =================== ============================================================================================================
Argument name(s) Required Default value Description
Expand All @@ -28,8 +28,7 @@ Argument name(s) Required Default value Description
--resume No False With this argument, the program will resume from the previous run.
====================== ========== =================== ============================================================================================================

Output
********
* Output

====================== ============== ===============================================================================================================================================================
File name File type Description
Expand All @@ -42,14 +41,14 @@ File name File type Description
`data.log` txt Gene ids being processed.
====================== ============== ===============================================================================================================================================================

2. ``xpore-diffmod``
``xpore-diffmod``
******************

* Input

Input
********
Output files from `xpore-dataprep`.

Usage example
****************
* Usage example

=================== ========== =============== ==============================================================================
Argument name(s) Required Default value Description
Expand All @@ -61,8 +60,7 @@ Argument name(s) Required Default value Description
--ids=LIST No [] Gene / Transcript ids to model.
=================== ========== =============== ==============================================================================

Output
*******
* Output

====================== =============== =================================================================================================================================================
File name File type Description
Expand Down

0 comments on commit 9a3da21

Please sign in to comment.