@@ -9,86 +9,47 @@ $pip install sigproSS
99Install your desired reference genome from the command line/terminal as follows (available reference genomes are: GRCh37, GRCh38, mm9, and mm10):
1010```
1111$ python
12- >>> from SigProfilerMatrixGenerator import install as genInstall
13- >>> genInstall.install('GRCh37')
12+ >> from SigProfilerMatrixGenerator import install as genInstall
13+ >> genInstall.install('GRCh37')
1414```
1515This will install the human 37 assembly as a reference genome. You may install as many genomes as you wish.
1616
1717open a python interpreter and import the SigProfilerExtractor module. Please see the examples of the functions.
1818
1919## FUNCTIONS
2020
21- ### _ importdata _
21+ ### importdata
2222
2323
2424 Imports the path of example data.
2525
26- importdata(inpute_type="vcf" )
26+ importdata()
2727
28- Example 1:
29- ----------
30- To import an example vcf project provided with the package:
31-
32- >>> from sigproSS import spss
33- >>> data = spss.importdata("vcf")
34-
35- This "data" variable can be used as a parameter of the first argument of the single_sample function.
36-
37-
38- Example 2:
39- ----------
40- To import an example csv96 file (for more description please the singple_sample_pcwag function) provided with the package:
41-
42- >>> from sigproSS import spss
43- >>> data = spss.importdata("pcwag96")
44-
45- This "data" variable can be used as a parameter of the first argument of the single_sample_pcwag function.
46-
47- Example 3:
48- ----------
49- To import an example csv192 file (for more description please the singple_sample_pcwag function) provided with the package:
50-
28+ Example:
29+ -------
5130 >>> from sigproSS import spss
52- >>> data = spss.importdata("pcwag192")
31+ >>> data = spss.importdata()
32+ This "data" variable can be used as a parameter of the first argument of the sigproSS function.
5333
54- This "data" variable can be used as a parameter of the second argument of the single_sample_pcwag function.
34+ To get help on the parameters and outputs of the "importdata" function, please write down the following line:
5535
56- ** To get more description on the parameters and outputs of the " importdata" function, please write down the following line: **
36+ >>> help(spss. importdata)
5737
58- >>> help(spss.importdata)
59-
60- ### _ single_sample_
38+ ### single_sample
6139
6240 Decompose the query samples into the global signatures.
6341
64- single_sample(data, output, ref="GRCh37", sig_database = "default", check_rules = True , exome=False)
42+ single_sample(vcf, outputdir , exome=False)
6543
6644 Example:
6745 -------
6846 >>> from sigproSS import spss
69- >>> data = spss.importdata() ##'you can put the path of your own vcf project here'
47+ >>> data = spss.importdata()
7048 >>> spss.single_sample(data, "results", ref="GRCh37", exome=False)
7149
72- ** To get more description on the parameters and outputs of the "single_sample " function, please write down the following line:**
50+ To get help on the parameters and outputs of the "importdata " function, please write down the following line:
7351
7452 >>> help(spss.single_sample)
75-
76- ### _ single_sample_pcwag_
77- Decompose the query samples those are in pcwag format into the global signatures.
78-
79- single_sample_pcwag(csv96, csv192="", output="results", par_one=0.01, par_two=0.025, n_cpu=-1)
80-
81- Example:
82- -------
83- >>> from sigproSS import spss, spss_pcwag
84- >>> csv96 = spss.importdata("pcwag96") #'you can put the path of your own csv96 file here'
85- >>> csv192 = spss.importdata("pcwag192") #''you can put the path of your own csv192 file here'
86- >>> spss_pcwag.single_sample_pcwag(csv96, csv192, output="example_output")
87-
88- ** To get more description on the parameters and outputs of the "single_sample_pcwag" function, please write down the following line:**
89-
90- >>> help(spss_pcwag.single_sample_pcwag)
91-
9253## COPYRIGHT
9354This software and its documentation are copyright 2018 as a part of the sigProfiler project. The SigProfilerExtractor 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.
9455
0 commit comments