Skip to content

Commit 04d6659

Browse files
committed
update readme and setupy for new version
1 parent 4705d76 commit 04d6659

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ Analyze.denovo_fit( samples,
101101
```
102102
### COSMIC Fit
103103
Attributes mutations of given Samples to input COSMIC signatures. Note that penalties associated with denovo fit and COSMIC fits are different.
104+
104105
<img src="SigProfilerAssignment/src/figures/cosmic_fit.jpg" alt="drawing" width="600"/>
105106

106107
```python
@@ -120,7 +121,7 @@ Analyze.cosmic_fit( samples,
120121
## Main Parameters
121122
| Parameter | Variable Type | Parameter Description |
122123
| --------------------- | -------- |-------- |
123-
| **samples** | String | Path to a tab delimilted file that contains the samples table where the rows are mutation types and colunms are sample IDs. |
124+
| **samples** | String | Path to a tab delimilted file that contains the samples table where the rows are mutation types and colunms are sample IDs. or Path to VCF files directory if input files are VCF Files. |
124125
| **output** | String | Path to the output folder. |
125126
| **signatures** | String | Path to a tab delimited file that contains the signature table where the rows are mutation types and colunms are signature IDs. |
126127
| **genome_build** | String | The reference genome build. List of supported genomes: "GRCh37", "GRCh38", "mm9", "mm10" and "rn6". The default value is "GRCh37". If the selected genome is not in the supported list, the default genome will be used. |
@@ -129,6 +130,7 @@ Analyze.cosmic_fit( samples,
129130
| **make_plots** | Boolean | Toggle on and off for making and saving all plots. Default value is True. |
130131
| **signature_subgroups** | List | Removes the signatures corresponding to specific subtypes for better fitting. The usage is given above. Default value is None. |
131132
| **exome** | Boolean | Defines if the exome renormalized signatures will be used. The default value is False. |
133+
| **vcf_opts**|Dict with keys 'project_name' and 'vcf_context'| Reqd options if vcf files are provided as input. 'project_name' key takes a string of the cohort of VCF samples and 'vcf_context' takes what context type of the mutation matrix to be considered for assignment. Valid options include '96', '6', '24', '4608', '288', '18','6144', '384', '1536', 'DINUC'|
132134
| **verbose** | Boolean | Prints statements. Default value is False. |
133135

134136

setup.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@
66
if os.path.exists("dist"):
77
shutil.rmtree("dist")
88

9-
VERSION = '0.0.10'
10-
9+
VERSION = '0.0.11'
1110

1211
with open('README.md') as f:
1312
long_description = f.read()
@@ -18,7 +17,7 @@ def write_version_py(filename='SigProfilerAssignment/version.py'):
1817
# THIS FILE IS GENERATED FROM SigProfilerAssignment SETUP.PY
1918
short_version = '%(version)s'
2019
version = '%(version)s'
21-
Update = '1. Reset reference genome to GRCh37 if a not supported genome is selected. 2. Add support for COSMIC exome reference signatures'
20+
Update = 'Integration of VCF files as input'
2221
2322
"""
2423
fh = open(filename, 'w')

0 commit comments

Comments
 (0)