|
a |
|
b/README.md |
|
|
1 |
Tweedieverse: Differential analysis of omics data based on the Tweedie distribution |
|
|
2 |
================ |
|
|
3 |
Himel Mallick, Ali Rahnavard |
|
|
4 |
2022-05-03 <img src="docs/logo.jpg" align="right" width="365px"/> |
|
|
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, Ali Rahnavard --> |
|
|
16 |
<!-- 2022-05-03 <img src="docs/logo.jpg" align="right" width="365px"/> --> |
|
|
17 |
|
|
|
18 |
Introduction |
|
|
19 |
------------ |
|
|
20 |
|
|
|
21 |
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). |
|
|
22 |
|
|
|
23 |
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). |
|
|
24 |
|
|
|
25 |
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. |
|
|
26 |
|
|
|
27 |
Installation |
|
|
28 |
------------ |
|
|
29 |
|
|
|
30 |
To install the latest release version of `Tweedieverse` from [CRAN](https://cran.r-project.org/) (**not yet available**) run the following command: |
|
|
31 |
|
|
|
32 |
``` r |
|
|
33 |
install.packages("Tweedieverse") |
|
|
34 |
library(Tweedieverse) |
|
|
35 |
``` |
|
|
36 |
|
|
|
37 |
Alternatively, the latest development version of `Tweedieverse` can be loaded using the following command (execute from within a fresh R session): |
|
|
38 |
|
|
|
39 |
``` r |
|
|
40 |
install.packages('devtools') |
|
|
41 |
library(devtools) |
|
|
42 |
devtools::install_github("himelmallick/Tweedieverse") |
|
|
43 |
library(Tweedieverse) |
|
|
44 |
``` |
|
|
45 |
|
|
|
46 |
After installing `Tweedieverse`, please make sure the following package versions are also installed (a prerequisite for zero-inflated Tweedie models): |
|
|
47 |
|
|
|
48 |
``` r |
|
|
49 |
devtools::install_version("statmod", version = "1.4.33", repos ="http://cran.us.r-project.org") |
|
|
50 |
``` |
|
|
51 |
|
|
|
52 |
``` r |
|
|
53 |
devtools::install_version("cplm", version = "0.7-8", repos = "http://cran.us.r-project.org") |
|
|
54 |
``` |
|
|
55 |
|
|
|
56 |
Basic Usage |
|
|
57 |
----------- |
|
|
58 |
|
|
|
59 |
``` r |
|
|
60 |
Tweedieverse(features, metadata, output) |
|
|
61 |
``` |
|
|
62 |
|
|
|
63 |
Input |
|
|
64 |
----- |
|
|
65 |
|
|
|
66 |
Tweedieverse requires two input files: |
|
|
67 |
|
|
|
68 |
- **features**: A data frame of omics features such as taxa, genes, transcripts, metabolites, etc. |
|
|
69 |
- **metadata**: A data frame of metadata to be associated. |
|
|
70 |
|
|
|
71 |
For full options, check out the [user manual](https://github.com/himelmallick/Tweedieverse/tree/master/vignettes) or type `?Tweedieverse` in your R console. |
|
|
72 |
|
|
|
73 |
Output |
|
|
74 |
------ |
|
|
75 |
|
|
|
76 |
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. |
|
|
77 |
|
|
|
78 |
Getting Started with Tweedieverse |
|
|
79 |
--------------------------------- |
|
|
80 |
|
|
|
81 |
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. |
|
|
82 |
|
|
|
83 |
Citation |
|
|
84 |
-------- |
|
|
85 |
|
|
|
86 |
To cite **`Tweedieverse`** in publications, please use: |
|
|
87 |
|
|
|
88 |
Mallick, H, Chatterjee, S, Chowdhury, S, Chatterjee, S, Rahnavard, A, Hicks, SC. [Differential expression of single-cell RNA-seq data using Tweedie models](https://onlinelibrary.wiley.com/doi/10.1002/sim.9430). Statistics in Medicine. 2022; 41( 18): 3492- 3510. doi:10.1002/sim.9430 |
|
|
89 |
|
|
|
90 |
To cite the **`Tweedieverse`** software, please use: |
|
|
91 |
|
|
|
92 |
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>. |
|
|
93 |
|
|
|
94 |
Issues |
|
|
95 |
------ |
|
|
96 |
|
|
|
97 |
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. |