Diff of /docs/index.rst [000000] .. [53737a]

Switch to unified view

a b/docs/index.rst
1
.. DeepProg documentation master file, created by
2
   sphinx-quickstart on Fri Dec  6 13:53:29 2019.
3
   You can adapt this file completely to your liking, but it should at least
4
   contain the root `toctree` directive.
5
6
Welcome to DeepProg's documentation!
7
====================================
8
9
.. toctree::
10
   :maxdepth: 2
11
12
   installation.md
13
   usage.md
14
   usage_ensemble.md
15
   usage_advanced.md
16
   usage_with_docker.md
17
   case_study.md
18
   usage_tuning.md
19
   LICENSE.rst
20
   ./api/simdeep.rst
21
22
23
Introduction
24
------------
25
26
This package allows to combine multi-omics data for individual samples together with survival. Using autoencoders (default) or any alternative embedding methods, the pipeline creates new set of features and identifies those linked with survival. In a second time, the samples are clustered with different possible strategies to obtain robust subtypes linked to survival. The robustness of the obtained subtypes can then be tested externally on one or multiple validation datasets and/or the *out-of-bags* samples.  The omic data used in the original study are RNA-Seq, MiR and Methylation. However, this approach can be extended to any combination of omic data. The current package contains the omic data used in the study and a copy of the model computed. However, it is easy to recreate a new model from scratch using any combination of omic data.
27
The omic data and the survival files should be in tsv (Tabular Separated Values) format and examples are provided. The deep-learning framework to produce the autoencoders uses Keras with either Theano / tensorflow/ CNTK as background.
28
29
.. image:: ./img/workflow.png
30
31
Access
32
------
33
34
The package is accessible at this link: https://github.com/lanagarmire/DeepProg.
35
36
Contribute
37
----------
38
39
- Issue Tracker: github.com/lanagarmire/DeepProg/issues
40
- Source Code: github.com/lanagarmire/DeepProg
41
42
Support
43
-------
44
45
If you are having issues, please let us know.
46
You can reach us using the following email address:
47
48
Olivier Poirion, Ph.D.
49
o.poirion@gmail.com
50
51
52
Data availability
53
-----------------
54
55
The matrices and the survival data used to compute the models are available here: https://genomemedicine.biomedcentral.com/articles/10.1186/s13073-021-00930-x/
56
57
Citation
58
--------
59
60
This package refers to our study published in Genome Biology: Multi-omics-based pan-cancer prognosis prediction using an ensemble of deep-learning and machine-learning models, https://genomemedicine.biomedcentral.com/articles/10.1186/s13073-021-00930-x
61
62
License
63
-------
64
65
The project is licensed under the MIT license.