Skip to content

Commit dab073d

Browse files
committed
updated readme
1 parent e862f90 commit dab073d

File tree

9 files changed

+11
-5
lines changed

9 files changed

+11
-5
lines changed

.DS_Store

0 Bytes
Binary file not shown.

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ spa_analyze( samples, output, signatures=None, signature_database=None,decompo
6767
genome_build="GRCh37", make_decomposition_plots=True, collapse_to_SBS96=True,connected_sigs=True, verbose=False):
6868
``` -->
6969
### Decompose Fit
70-
Decomposes the De Novo Signatures into COSMIC Signatures and assigns COSMIC signatures into samples
70+
Decomposes the De Novo Signatures into COSMIC Signatures and assigns COSMIC signatures into samples.
7171
<img src="SigProfilerAssignment/src/figures/decomp_pic.jpg" alt="drawing" width="600"/>
7272

7373
```python
@@ -82,7 +82,8 @@ Analyze.decompose_fit(samples,
8282
signature_subgroups=signature_subgroups)
8383
```
8484
### *De Novo* Fit
85-
<img src="SigProfilerAssignment/src/figures/cosmic_pic.jpg" alt="drawing" width="600"/>
85+
Attributes mutations of given Samples to input denovo signatures.
86+
<img src="SigProfilerAssignment/src/figures/denovo_fit.jpg" alt="drawing" width="600"/>
8687

8788
```python
8889
from SigProfilerAssignment import Analyzer as Analyze
@@ -93,8 +94,9 @@ Analyze.denovo_fit( samples,
9394
genome_build="GRCh37",
9495
verbose=False)
9596
```
96-
### Cosmic Fit
97-
<img src="SigProfilerAssignment/src/figures/cosmic_pic.jpg" alt="drawing" width="600"/>
97+
### COSMIC Fit
98+
Attributes mutations of given Samples to input COSMIC signatures. Note that penalties associated with denovo fit and COSMIC fits are different.
99+
<img src="SigProfilerAssignment/src/figures/cosmic_fit.jpg" alt="drawing" width="600"/>
98100

99101
```python
100102
from SigProfilerAssignment import Analyzer as Analyze
@@ -108,15 +110,19 @@ Analyze.cosmic_fit( samples,
108110
signature_subgroups=signature_subgroups,
109111
make_plots=True)
110112
```
111-
## Parameters
113+
## Main Parameters
112114
| Parameter | Variable Type | Parameter Description |
113115
| --------------------- | -------- |-------- |
114116
| **signatures** | String | Path to a tab delimited file that contains the signaure table where the rows are mutation types and colunms are signature IDs. |
115117
| **activities** | String | Path to a tab delimilted file that contains the activity table where the rows are sample IDs and colunms are signature IDs. |
116118
| **samples** | String | Path to a tab delimilted file that contains the activity table where the rows are mutation types and colunms are sample IDs. |
117119
| **output** | String | Path to the output folder. |
118120
| **genome_build** | String | The genome type. Example: "GRCh37", "GRCh38", "mm9", "mm10". The default value is "GRCh37" |
121+
| **new_signature_thresh_hold**|Float | Parameter in Cosine similarity to declare a new signature. Applicable for decompose fit only. The default value is 0.8 |
122+
| **make_plots** | Boolean | Toggle on and off for making and saving all plots. Default value is True. |
123+
| **signature_subgroups** | List | Removes the signatures corresponding to specific subtypes for better fitting. The usage is given above. Default value is None. |
119124
| **verbose** | Boolean | Prints statements. Default value is False. |
125+
120126
121127

122128
#### SPA analysis Example

SigProfilerAssignment/.DS_Store

0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
200 KB
Loading
198 KB
Loading

0 commit comments

Comments
 (0)