Skip to content

Commit b56a11d

Browse files
author
JLTrincado
authored
Merge pull request #11 from comprna/JLTrincado-patch-1
Modified README, by JC
2 parents b102eec + 6d6f335 commit b56a11d

File tree

1 file changed

+9
-19
lines changed

1 file changed

+9
-19
lines changed

README.md

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -65,26 +65,10 @@ We provide below detailed information on how to install and run SUPPA. Please jo
6565

6666
SUPPA has been developed in Python 3.4.
6767

68-
If necessary, to install python3 we recommend to download from the official site ( https://www.python.org/downloads/ ) the corresponding version for your OS.
68+
SUPPA can be installed directly from Python Package Index (PyPI) by running the following command:
6969

70-
SUPPA uses the following modules:
71-
72-
- SciPy ( 0.15.1 )
73-
- NumPy ( 1.11.0 )
74-
- Pandas ( 0.18.0 )
75-
- statsmodels ( 0.6.1 )
76-
- scikit-learn ( 0.16.1 )
77-
78-
In case you do not have already these modules, we reccomend to use pip3 to install the specific version of the modules. To install pip3, please go to the official site ( https://pip.pypa.io/en/latest/installing/ ),
79-
download the file "get-pip.py", and run the following command:
80-
```
81-
python3 get-pip.py
82-
sudo pip3 install --upgrade pip3
83-
```
84-
85-
Then, to install the modules:
8670
```
87-
sudo pip3 install scipy==0.15.1 numpy==1.11.0 pandas==0.18.0 statsmodels==0.6.1 scikit-learn==0.16.1
71+
pip install SUPPA==2.2.1
8872
```
8973

9074
SUPPA is ready to use. Once downloaded, it can be used directly from the command line.
@@ -448,9 +432,15 @@ List of options available:
448432

449433
- **-al** | **--alpha**: Family-wise error rate to use for the multiple test correction. (Default: 0.05).
450434

435+
- **-s** | **--save_tpm_events**: Boolean. If True, the average log TPM of the events will be saved in an external file (Default: False).
436+
437+
- **-c** | **--combination**: Boolean. If True, SUPPA perform the analysis between all the possible combinations of conditions (Default: False).
438+
- **-me** | **--median**: Boolean. If True, SUPPA use the median to calculate the Delta PSI. (Default: False).
439+
- **-th TPM_TH** | **--tpm-threshold TPM_TH**: Minimum transcript average TPM value within-replicates and between-conditions to be included in the analysis. (Default: 1.0).
440+
451441
- **-o** | **--output**: Name of the output
452442

453-
- **-h** | **--help**: display the help message describing the different parameters
443+
- **-h** | **--help**: display the help message describing the different parameters
454444

455445
An example of the usage of the program is:
456446

0 commit comments

Comments
 (0)