Learn R Programming

⚠️There's a newer version (4.2.6) of this package.Take me there.

Quick start

Welcome to the propr GitHub page!

The bioinformatic evaluation of gene co-expression often begins with correlation-based analyses. However, this approach lacks statistical validity when applied to relative data. This includes, for example, biological count data generated by high-throughput RNA-sequencing, chromatin immunoprecipitation (ChIP), ChIP-sequencing, Methyl-Capture sequencing, and other techniques. This package implements several metrics for proportionality, including phi [Lovell et al (2015)] and rho [Erb and Notredame (2016)]. This package also implements several metrics for differential proportionality. Unlike correlation, these measures give the same result for both relative and absolute data.

library(devtools)
devtools::install_github("tpq/propr")
library(propr)

Further reading

To learn more about proportionality, we refer the reader to the relevant literature.

citation("propr")
## 
## To cite propr in publications use:
## 
##   Quinn T, Richardson MF, Lovell D, Crowley T (2017) propr: An
##   R-package for Identifying Proportionally Abundant Features Using
##   Compositional Data Analysis. bioRxiv: doi:10.1101/104935
## 
##   Erb I, Quinn T, Lovell D, Notredame C (2017) Differential
##   Proportionality - A Normalization-Free Approach To Differential
##   Gene Expression. bioRxiv: doi:10.1101/134536
## 
##   Lovell D, Pawlowsky-Glahn V, Egozcue JJ, Marguerat S, Bahler J
##   (2015) Proportionality: A Valid Alternative to Correlation for
##   Relative Data. PLoS Comput Biol 11(3):
##   doi:10.1371/journal.pcbi.1004075
## 
##   Erb I, Notredame C (2016) How should we measure proportionality
##   on relative gene expression data? Theory Biosci 135(1):
##   doi:10.1007/s12064-015-0220-8

Copy Link

Version

Install

install.packages('propr')

Monthly Downloads

49

Version

3.0.6

License

GPL-2

Issues

Pull Requests

Stars

Forks

Maintainer

Thomas Quinn

Last Published

August 1st, 2017

Functions in propr (3.0.6)

calculateThetaW_old

Calculate Weighted Theta
calculateTheta_old

Calculate Theta
aldex2propr

Import ALDEx2 Object
alphaTheta

Calculate alpha Theta
alphaTheta_old

Calculate alpha Theta
calculateFDR

Calculate FDR Cutoffs
calculateFDR_old

Calculate FDR Cutoffs
calculateTheta

Calculate Theta
abstract

Abstract Two propr Objects
aldex.cor

Correlate CLR with a Continuous Measurement
dendroCheck

Dendrogram Plot Check
differentialCheck

Differential Proportionality Check
permuteTheta_naive

Permute Theta
ggdend

Dendrogram Plot Wrapper
lr2cor

Correlate CLR with a Continuous Measurement
pd.d

Example propd Object
pd.e

Example propd Object
migraph

igraph Helper Functions
multiplot

Plot Multiple Graphs
permuteTheta_prime

Permute Theta
plotCheck

Plot Check
mail

Mock Mail Count Data
marg.abs

Example Absolute mRNA
permuteTheta

Permute Theta
permuteTheta_false

Permute Theta
proprPairs

Recasts proportionality matrix as a table of feature pairs.
proprPerb

Calculate proportionality metric rho (Erb 2016).
proprPhit

Calculate proportionality metric phi (Lovell 2015).
proprSym

Symmetrizes a proportionality matrix.
progress

Make Progress Bar
promptCheck

Feature Check
top.counts

Example propr Object
top.lr

Example propr Object
permuteTheta_old

Permute Theta
prop2prob

Calculate Probability from Proportionality
propd

The propd Method
proprTri

Retrieve the lower left triangle of a proportionality matrix.
proprVLR

Calculates the variance of the log of the ratios.
caneToad.counts

Example Cane Toad Count Data
caneToad.groups

Example Cane Toad Group Data
packageCheck

Package Check
pals

Calculate PALs for Pairs
proprALR

Calculates the additive log-ratio transformation.
proprCLR

Calculates the centered log-ratio transformation.
proportionality

Calculate Proportionality
propr

The propr Package
visualize

Visualize Proportionality