Skip to content

Commit ad6f96e

Browse files
committed
Documentation index corrected
1 parent 7c0fcb9 commit ad6f96e

3 files changed

Lines changed: 18 additions & 12 deletions

File tree

docs/assets/stylesheets/extra.css

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,7 @@
2020
border-radius: 8px;
2121
}
2222

23+
p {
24+
text-align: justify
25+
}
26+

docs/index.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,33 @@
1-
SigProfilerAssignment
2-
=====================
3-
4-
![test](assets/images/SigProfilerAssignment.png)
1+
# SigProfilerAssignment
52

3+
![Logo](assets/images/SigProfilerAssignment.png)
64

75
----------
86

7+
**SigProfilerAssignment** is a Python framework that assigns and decomposes mutational signatures in individual samples and individual somatic mutations.
8+
9+
Refitting of known mutational signatures is a numerical optimization approach that not only identifies the set of operative mutational signatures in a particular sample, but also quantifies the number of mutations attributed to each signature detected in that sample. In addition to refitting known reference signatures, the tool can decompose _de novo_ extracted signatures into known reference signatures, facilitating biological interpretation and comparison with established catalogs.
10+
11+
It supports multiple mutation contexts and genome builds, provides confidence estimation and signature activity thresholds, and generates detailed visual and tabular outputs to aid downstream analyses. The tool refits different types of reference mutational signatures, including COSMIC [SBS][1], [DBS][2], [ID][3], and [CN][4] signatures, as well as custom signature databases.
912

10-
SigProfilerAssignment is a [python](https://www.python.org/) framework that assigns previously known mutational signatures to individual samples and individual somatic mutations. The tool refits different types of reference mutational signatures, including COSMIC [SBS][1], [DBS][2], [ID][3], and [CN][4] signatures, as well as custom signature databases. Refitting of known mutational signatures is a numerical optimization approach that not only identifies the set of operative mutational signatures in a particular sample, but also quantifies the number of mutations assigned to each signature found in that sample. SigProfilerAssignment makes use of [SigProfilerMatrixGenerator][5] and [SigProfilerPlotting][6], seamlessly integrating with other [SigProfiler tools][7].
13+
**SigProfilerAssignment** makes use of [SigProfilerMatrixGenerator][5] and [SigProfilerPlotting][6], enabling seamless integration with other tools in the SigProfiler suite.
1114

12-
The SigProfilerAssignment library can be found on GitHub [here][8]. For users that prefer working in an R environment, we provide an R wrapper (SigProfilerAssignmentR) that can be found on GitHub [here][9].
15+
The SigProfilerAssignment library is available on [GitHub](https://github.com/SigProfilerSuite/SigProfilerAssignment) and [PyPI](https://pypi.org/project/SigProfilerAssignment)
1316

1417

1518
----------
1619

1720
### Citation
18-
Díaz-Gay, M., Vangara, R., Barnes, M., ... & Alexandrov, L. B. (2023). Assigning mutational signatures to individual samples and individual somatic mutations with SigProfilerAssignment, bioRxiv, 2023-07. doi: https://doi.org/10.1101/2023.07.10.548264
21+
22+
Díaz-Gay M, Vangara R, Barnes M, Wang X, Islam SMA, Vermes I, Duke S, Narasimman NB, Yang T, Jiang Z, Moody S, Senkin S, Brennan P, Stratton MR, Alexandrov LB. Assigning mutational signatures to individual samples and individual somatic mutations with SigProfilerAssignment. *Bioinformatics*. 2023;39(12):btad756. [https://doi.org/10.1093/bioinformatics/btad756](https://doi.org/10.1093/bioinformatics/btad756)
1923

2024
### License
21-
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.
25+
26+
This software and its documentation are part of the SigProfiler project and are copyrighted © 2022. 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.
2227

2328
### Contact
24-
Please address any queries or bug reports to Raviteja Vangara at rvangara@health.ucsd.edu or Marcos Díaz-Gay at mdiazgay@health.ucsd.edu.
2529

30+
For questions, support requests, or bug reports, please contact the SigProfilerSuite team via GitHub [issues](https://github.com/SigProfilerSuite/SigProfilerAssignment/issues) or by email at [contact@sigprofilersuite.org](mailto:contact@sigprofilersuite.org).
2631

2732
[1]: https://cancer.sanger.ac.uk/cosmic/signatures/SBS/
2833
[2]: https://cancer.sanger.ac.uk/signatures/dbs/

mkdocs.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@ repo_url: https://github.com/SigProfilerSuite/SigProfilerAssignment
55
docs_dir: docs
66
site_url: https://sigprofilersuite.github.io/SigProfilerAssignment/
77

8-
not_in_nav: |
9-
home.md
10-
118
use_directory_urls: false
129

1310
theme:

0 commit comments

Comments
 (0)