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)
?propr

Further reading

To learn more about proportionality, please see the vignettes and other 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. Scientific Reports 7(16252):
##   doi:10.1038/s41598-017-16520-0
## 
##   Erb I, Quinn T, Lovell D, Notredame C (2017) Differential
##   Proportionality - A Normalization-Free Approach To Differential
##   Gene Expression. Proceedings of CoDaWork 2017, The 7th
##   Compositional Data Analysis Workshop; available under bioRxiv
##   134536: doi:10.1101/134536
## 
##   Quinn T, Erb I, Richardson MF, Crowley T (2017) Understanding
##   sequencing data as compositions: an outlook and review. bioRxiv:
##   doi:10.1101/206425
## 
##   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
## 
## To see these entries in BibTeX format, use 'print(<citation>,
## bibtex=TRUE)', 'toBibtex(.)', or set
## 'options(citation.bibtex.max=999)'.

Copy Link

Version

Install

install.packages('propr')

Monthly Downloads

166

Version

3.1.8

License

GPL-2

Issues

Pull Requests

Stars

Forks

Maintainer

Thomas Quinn

Last Published

March 21st, 2018

Functions in propr (3.1.8)

aldex2propr

Import ALDEx2 Object
ivar2index

Build Index from ivar Argument
calculateTheta

Calculate Theta
alphaTheta

Calculate alpha Theta
alphaTheta_old

Calculate alpha Theta
lr2cor

Correlate CLR with a Continuous Measurement
aldex.cor

Correlate CLR with a Continuous Measurement
permuteTheta

Permute Theta
permuteTheta_false

Permute Theta
permuteTheta_old

Permute Theta
differentialCheck

Differential Proportionality Check
calculateFDR_old

Calculate FDR Cutoffs
permuteTheta_naive

Permute Theta
migraph

igraph Helper Functions
ggdend

Dendrogram Plot Wrapper
abstract

Abstract Two propr Objects
pd.d

Example propd Object
multiplot

Plot Multiple Graphs
pd.e

Example propd Object
marg.abs

Example Absolute mRNA
calculateThetaW_old

Calculate Weighted Theta
proprALR

Calculates the additive log-ratio transformation.
prop2prob

Calculate Probability from Proportionality
caneToad.groups

Example Cane Toad Group Data
packageCheck

Package Check
proprCLR

Calculates the centered log-ratio transformation.
progress

Make Progress Bar
dendroCheck

Dendrogram Plot Check
pals

Calculate PALs for Pairs
top.lr

Example propr Object
permuteTheta_prime

Permute Theta
proportionality

Calculate Proportionality
calculateTheta_old

Calculate Theta
visualize

Visualize Proportionality
plotCheck

Plot Check
proprPairs

Recasts proportionality matrix as a table of feature pairs.
caneToad.counts

Example Cane Toad Count Data
propr

The propr Package
proprPerb

Calculate proportionality metric rho (Erb 2016).
mail

Mock Mail Count Data
proprPhit

Calculate proportionality metric phi (Lovell 2015).
promptCheck

Feature Check
proprSym

Symmetrizes a proportionality matrix.
propd

The propd Method
ratios

Recast Matrix as Feature Ratios
proprTri

Retrieve the lower left triangle of a proportionality matrix.
top.counts

Example propr Object
proprVLR

Calculates the variance of the log of the ratios.
alphaThetaW_old

Calculate Weighted Theta
calculateFDR

Calculate FDR Cutoffs