Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cdbope committed Jun 25, 2024
1 parent 26495da commit af1f95c
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
Binary file modified .DS_Store
Binary file not shown.
13 changes: 10 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ friendly interface and data visualization routines.

Mutation signature analysis package
-----------------------------------
.. image:: docs/images/pypi-logo.png
:target: https://pypi.org/project/starsigndna/
:alt: PyPI

.. image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://opensource.org/licenses/MIT
Expand All @@ -28,16 +31,20 @@ Features
Stable release
--------------

To install StarSign, run this command in your terminal::
To install StarSign,

you can install the package directly from PyPi::

pip install starsigndna

Alternatively, you can install it via terminal by running this command::

1. Download StarSign from https://github.com/uio-bmi/StarSignDNA
2. Unzip StarSignDNA-master.zip
3. cd StarSigndna-master/
4. pip install -e .

Alternatively, you can install the package directly from PyPi::

pip install starsigndna
Getting started
---------------

Expand Down
2 changes: 1 addition & 1 deletion starsigndna/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ def refit(matrix_file: Annotated[str, typer.Argument(help='Tab separated matrix
S = S.to_numpy().astype(float)
M = M.to_numpy().astype(float)
O = read_opportunity(M, opportunity_file)
lambd = 0.7
lambd = 4

if (M.ndim == 2 and M.shape[0] == 1) or M.ndim == 1:
boostrap_M = _bootstrap(M,n_bootstraps)
Expand Down

0 comments on commit af1f95c

Please sign in to comment.