Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mikelkou committed Dec 8, 2023
1 parent abc6f24 commit 97c3297
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ pip install favapy
```

## favapy as Python library
Read the jupyter-notebook: [How_to_use_favapy_in_a_notebook](https://github.com/mikelkou/fava/blob/main/How_to_use_favapy_in_a_notebook.ipynb)
Read the [How_to_use_favapy_in_a_notebook](https://github.com/mikelkou/fava/blob/main/How_to_use_favapy_in_a_notebook.ipynb) or the [documentation](https://fava.readthedocs.io/en/latest/).

favapy supports both AnnData objects and count/abundance matrices.

Expand All @@ -34,15 +34,13 @@ Run favapy from the command line as follows:
favapy <path-to-data-file> <path-to-save-output>
```

### Optional parameters:
#### Optional parameters:
```
-t Type of input data ('tsv' or 'csv'). Default value = 'tsv'.
-n The number of interactions in the output file (with both directions, proteinA-proteinB and proteinB-proteinA). Default value = 100000.
-cor Type of correlation method ('pearson' or 'spearman'). Default value = 'pearson'
-c The cut-off on the Correlation scores.The scores can range from 1 (high correlation) to -1 (high anti-correlation). This option overwrites the number of interactions. Default value = None.
-d The dimensions of the intermediate\hidden layer. Default value depends on the input size.
Expand All @@ -53,6 +51,8 @@ favapy <path-to-data-file> <path-to-save-output>
-b The batch size. Default value = 32.
-cor Type of correlation method ('pearson' or 'spearman'). Default value = 'pearson'
```

Expand Down

0 comments on commit 97c3297

Please sign in to comment.