Switch to unified view

a b/vignettes/Tweedieverse-vignette.md
1
Tweedieverse: Differential analysis of omics data based on the Tweedie distribution
2
================
3
Himel Mallick, Ali Rahnavard
4
2022-05-03
5
6
-   [Introduction](#introduction)
7
-   [Installation](#installation)
8
-   [Basic Usage](#basic-usage)
9
-   [Input](#input)
10
-   [Output](#output)
11
-   [Getting Started with Tweedieverse](#getting-started-with-tweedieverse)
12
-   [Citation](#citation)
13
-   [Issues](#issues)
14
15
<!-- Himel Mallick -->
16
<!-- 2021-03-03 <img src="docs/logo.jpg" align="right" width="365px"/> -->
17
Introduction
18
------------
19
20
Tweedieverse is an R package for differential analysis of omics data implementing a range of statistical methodology based on the [Tweedie distribution](https://en.wikipedia.org/wiki/Tweedie_distribution).
21
22
Unlike traditional single-omics tools, Tweedieverse is technology-agnostic and can be applied to both count and continuous measurements arising from diverse high-throughput technologies (e.g., transcript abundances from bulk and single-cell RNA-Seq studies in the form of UMI counts or non-UMI counts, microbiome taxonomic and functional profiles in the form of counts or relative abundances, and compound abundance levels or peak intensities from metabolomics and other mass spectrometry-based experiments, among others).
23
24
The software includes multiple analysis methods (e.g., self-adaptive, zero-inflated, and non-zero-inflated statistical models) as well as multiple customization options such as the inclusion of random effects and multiple covariates along with several data exploration capabilities and visualization modules in a unified estimation umbrella.
25
26
Installation
27
------------
28
29
To install the latest release version of `Tweedieverse` from [CRAN](https://cran.r-project.org/) (**not yet available**) run the following command:
30
31
``` r
32
install.packages("Tweedieverse")
33
library(Tweedieverse)
34
```
35
36
Alternatively, the latest development version of `Tweedieverse` can be loaded using the following command (execute from within a fresh R session):
37
38
``` r
39
install.packages('devtools')
40
library(devtools)
41
devtools::install_github("himelmallick/Tweedieverse")
42
library(Tweedieverse)
43
```
44
45
After installing `Tweedieverse`, please make sure the following package versions are also installed (a prerequisite for zero-inflated Tweedie models):
46
47
``` r
48
devtools::install_version("statmod", version = "1.4.33", repos ="http://cran.us.r-project.org")
49
```
50
51
``` r
52
devtools::install_version("cplm", version = "0.7-8", repos = "http://cran.us.r-project.org")
53
```
54
55
Basic Usage
56
-----------
57
58
``` r
59
Tweedieverse(features, metadata, output)
60
```
61
62
Input
63
-----
64
65
Tweedieverse requires two input files:
66
67
-   **features**: A data frame of omics features such as taxa, genes, transcripts, metabolites, etc.
68
-   **metadata**: A data frame of metadata to be associated.
69
70
For full options, check out the [user manual](https://github.com/himelmallick/Tweedieverse/tree/master/vignettes) or type `?Tweedieverse` in your R console.
71
72
Output
73
------
74
75
A data frame containing coefficient estimates, p-values, and q-values (multiplicity-adjusted p-values) are returned, along with other parameter estimates from the fitted per-feature models.
76
77
Getting Started with Tweedieverse
78
---------------------------------
79
80
Check out the [Tweedie Labs](https://github.com/himelmallick/TweedieLabs/) repository for a collection of walkthrough tutorials (available as source codes, cloud-compatible images, and installable packages) on how to use Tweedieverse with various omics data types.
81
82
Citation
83
--------
84
85
To cite **`Tweedieverse`** in publications, please use:
86
87
Mallick H et al. (2021). [Differential Expression of Single-cell RNA-seq Data using Tweedie Models](https://www.biorxiv.org/content/10.1101/2021.03.28.437378v1). bioRxiv, <https://doi.org/10.1101/2021.03.28.437378>.
88
89
To cite the **`Tweedieverse`** software, please use:
90
91
Mallick H et al. (2021). [Tweedieverse - A Unified Statistical Framework for Differential Analysis of Multi-omics Data](https://github.com/himelmallick/Tweedieverse). R package, <https://github.com/himelmallick/Tweedieverse>.
92
93
Issues
94
------
95
96
We are happy to troubleshoot any issues with the package. Please contact the maintainer via email or [open an issue](https://github.com/himelmallick/tweedieverse/issues) in the GitHub repository.