Diff of /docs/index.md [000000] .. [548210]

Switch to unified view

a b/docs/index.md
1
# Welcome to OpenOmics's documentation!
2
3
[![PyPI version](https://badge.fury.io/py/openomics.svg)](https://badge.fury.io/py/openomics)
4
[![Documentation Status](https://readthedocs.org/projects/openomics/badge/?version=latest)](https://openomics.readthedocs.io/en/latest/?badge=latest)
5
[![OpenOmics](https://github.com/JonnyTran/OpenOmics/actions/workflows/python-package.yml/badge.svg?branch=master)](https://github.com/JonnyTran/OpenOmics/actions/workflows/python-package.yml)
6
[![codecov](https://codecov.io/gh/JonnyTran/OpenOmics/branch/master/graph/badge.svg?token=WAN3PJwM42)](https://codecov.io/gh/JonnyTran/OpenOmics)
7
8
This Python package provide a series of tools to integrate and query the genomics, transcriptomics, proteomics, and
9
clinical data (aka, the multi-omics data). With scalable data-frame manipulation tools, OpenOmics facilitates the common
10
coding tasks when preparing data for RNA-seq bioinformatics analysis.
11
12
## Features
13
14
- Provides a bioinformatics workflow to generate integrative results from multi-omics data.
15
- Facilitates integration of various bio-databases, multi-omics expression, genomics, and clinical data.
16
- Highly flexible to different data types and missing data.
17
- Provides researchers with means to consistently store and explore their experimental datasets.
18
- Enables scalable performance with parallel computing, while easily configurable to deploy on both single machine and a
19
  cluster.
20
21
## Table of Content
22
23
```{toctree}
24
:maxdepth: 2
25
:caption: Using OpenOmics Python API
26
:name: mastertoc
27
installation
28
usage/getting-started
29
usage/import-your-dataset
30
usage/annotate-external-databases
31
usage/network-data
32
usage/preprocess-downstream-analysis
33
```
34
35
```{toctree}
36
:maxdepth: 1
37
:caption: API Reference
38
39
modules/openomics.multiomics
40
modules/openomics.annotate
41
modules/openomics.database.annotation
42
modules/openomics.database.sequence
43
modules/openomics.database.interaction
44
modules/openomics.database.disease
45
modules/openomics.database.ontology
46
modules/openomics.utils
47
```
48
49
50
```{toctree}
51
:maxdepth: 1
52
:caption: MISC
53
54
misc/faq
55
```
56
57
58
```{toctree}
59
:maxdepth: 1
60
:caption: Contributing and releases
61
62
contributing
63
history
64
```