Skip to content

Commit d69d9dd

Browse files
committed
Add segmentation file example to README
1 parent ef3a587 commit d69d9dd

File tree

1 file changed

+37
-2
lines changed

1 file changed

+37
-2
lines changed

README.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,9 @@ Analyze.decompose_fit(samples,
8686
exclude_signature_subgroups=exclude_signature_subgroups,
8787
exome=False)
8888
```
89+
90+
## Analysis
91+
8992
### *De Novo* Fit
9093
Attributes mutations of given Samples to input denovo signatures.
9194
<img src="SigProfilerAssignment/src/figures/denovo_fit.jpg" alt="drawing" width="600"/>
@@ -137,7 +140,9 @@ Analyze.cosmic_fit( samples,
137140

138141
139142

140-
#### SPA analysis Example for a matrix
143+
## Examples
144+
145+
### SPA analysis - Example for a matrix
141146

142147

143148
```python
@@ -167,7 +172,7 @@ Analyze.cosmic_fit( samples,
167172

168173
```
169174

170-
#### SPA analysis Example for input vcf files
175+
### SPA analysis - Example for input vcf files
171176

172177

173178
```python
@@ -198,6 +203,36 @@ Analyze.cosmic_fit( samples,
198203
exome=False)
199204

200205
```
206+
207+
### SPA analysis - Example for an input multi-sample segmentation file
208+
209+
210+
```python
211+
#import modules
212+
import SigProfilerAssignment as spa
213+
from SigProfilerAssignment import Analyzer as Analyze
214+
215+
#set directories and paths to signatures and samples
216+
dir_inp = spa.__path__[0]+'/data/Examples/'
217+
samples = spa.__path__[0]+'/data/cnvtest/all.breast.ascat.summary.sample.tsv' # segmentation file
218+
output = "output_example/"
219+
220+
#Analysis of SP Assignment
221+
Analyze.cosmic_fit( samples,
222+
output,
223+
input_type="seg:ASCAT_NGS",
224+
context_type="CNV48",
225+
signatures=None,
226+
signature_database=None,
227+
genome_build="GRCh37",
228+
cosmic_version=3.3,
229+
verbose=False,
230+
collapse_to_SBS96=False,
231+
make_plots=True,
232+
exclude_signature_subgroups=None,
233+
exome=False)
234+
```
235+
201236
## <a name="copyright"></a> Copyright
202237
This software and its documentation are copyright 2022 as a part of the SigProfiler project. The SigProfilerAssignment framework is free software and is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
203238

0 commit comments

Comments
 (0)