Package: RCM 1.29.0

Stijn Hawinkel

RCM: Fit row-column association models with the negative binomial distribution for the microbiome

Combine ideas of log-linear analysis of contingency table, flexible response function estimation and empirical Bayes dispersion estimation for explorative visualization of microbiome datasets. The package includes unconstrained as well as constrained analysis. In addition, diagnostic plot to detect lack of fit are available.

Authors:Stijn Hawinkel [cre, aut]

RCM_1.29.0.tar.gz
RCM_1.29.0.zip(r-4.7)RCM_1.29.0.zip(r-4.6)RCM_1.29.0.zip(r-4.5)
RCM_1.29.0.tgz(r-4.6-any)RCM_1.29.0.tgz(r-4.5-any)
RCM_1.29.0.tar.gz(r-4.7-any)RCM_1.29.0.tar.gz(r-4.6-any)
RCM_1.29.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
RCM/json (API)

# Install 'RCM' in R:

install.packages('RCM', repos = c('https://bioc.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/centerforstatistics-ugent/rcm/issues

Datasets:

Zeller - Microbiomes of colorectal cancer patients and healthy controls

On BioConductor:RCM-1.29.0(bioc 3.24)RCM-1.28.0(bioc 3.23)

metagenomics dimensionreduction microbiome visualization ordination phyloseq rcm

7.06 score 16 stars 16 scripts 15 mentions 12 exports 73 dependencies

Last updated from:a419a050b8. Checks:1 NOTE, 9 OK. Indexed: yes.

Target	Result	Time
bioc-checks	NOTE	181
linux-devel-x86_64	OK	393
source / vignettes	OK	302
linux-release-x86_64	OK	427
macos-release-arm64	OK	251
macos-oldrel-arm64	OK	235
windows-devel	OK	251
windows-release	OK	330
windows-oldrel	OK	338
wasm-release	OK	162

Exports:addOrthProjection buildConfMat checkAlias extractCoord getDevianceRes inertia liks permanova plotRespFun RCM RCM_NB residualPlot

Dependencies:ade4 alabama ape Biobase BiocGenerics biomformat Biostrings cli cluster codetools cpp11 crayon curl data.table digest edgeR farver foreach generics ggplot2 glue gtable igraph IRanges isoband iterators jsonlite labeling lattice lifecycle limma locfit magrittr MASS Matrix mgcv multtest nleqslv nlme numDeriv permute phyloseq pixmap pkgconfig plyr quadprog quantmod R6 RColorBrewer Rcpp RcppArmadillo reshape2 rlang S4Vectors S7 scales Seqinfo sp statmod stringi stringr survival tensor tseries TTR vctrs vegan VGAM viridisLite withr xts XVector zoo

Manual for the RCM pacakage

Rendered fromRCMvignette.Rmdusingknitr::rmarkdown

Last update: 2023-03-29
Started: 2017-12-14

Citation

Development and contributors

Readme and manuals

Help Manual

Help page	Topics
This function adds orthogonal projections to a given plot	addOrthProjection
An auxiliary R function to 'array' multiply an array with a vector, kindly provided by Joris Meys	arrayprod
A function to build a centering matrix based on a dataframe	buildCentMat
A function to build the confounder matrices	buildConfMat
buildConfMat.character	buildConfMat,character-method
buildConfMat.data.frame	buildConfMat,data.frame-method
A function to build the covariate matrix of the constraints	buildCovMat
A function to build the design matrix	buildDesign
Check for alias structures in a dataframe, and throw an error when one is found	checkAlias
Constrained correspondence analysis with adapted powers	constrCorresp
Replace missing entries in X by their expectation to set their contribution to the estimating equations to zero	correctXMissingness
A function to extract deviances for all dimension, including after filtering on confounders	deviances
A function that returns the value of the partial derivative of the log-likelihood ratio to alpha, keeping the response functions fixed	dLR_nb
A score function for the column components of the independence model (mean relative abundances)	dNBabundsOld
A score function for the row components of the independence model (library sizes)	dNBlibSizes
The score function of the response function for 1 taxon at the time	dNBllcol_constr
The score function of the general response function	dNBllcol_constr_noLab
Estimation of the parameters of a third degree GLM	dNBllcolNP
A score function for the estimation of the column scores in an unconstrained RC(M) model	dNBllcolOld
A score function of the NB for the row scores	dNBllrow
A score function for the psi of a given dimension	dNBpsis
A function that returns the coordinates of an ellipse	ellipseCoord
Estimate the overdispersion	estDisp
A function to estimate the taxon-wise NB-params	estNBparams
A function to estimate the NB-params ignoring the taxon labels	estNBparamsNoLab
Estimate the taxon-wise response functions non-parametrically	estNPresp
A function to extract plotting coordinates, either for plot.RCM or to export to other plotting software	extractCoord
A function to extract a matrix of expected values for any dimension of the fit	extractE
Filters out the effect of known confounders. This is done by fitting interactions of every taxon with the levels of the confounders. It returns a modified offset matrix for the remainder of the fitting procedure.	filterConfounders
A function to calculate the matrix of deviance residuals.	getDevianceRes
ACalculate the matrix of deviance residuals	getDevMat
Get coordinates of a distance object of n observations for the provided indices	getDistCoord
A function to extract the influence for a given parameter index	getInflCol
Extract the influence of all observations on a given row score	getInflRow
Integrate the spline of an vgam object	getInt
Extract the logged likelihood of every count	getLogLik
A function to construct a model matrix of a certain degree	getModelMat
Return a matrix of row scores	getRowMat
Gram-Schmidt orthogonalization of vectors	GramSchmidt
Define linear equality constraints for env. gradient	heq_nb
The jacobian of the linear equality constraints	heq_nb_jac
Functions to indent the plot to include the entire labels	indentPlot
Calculate the log-likelihoods of all possible models	inertia
Jacobian of the constrained analysis with linear response function.	JacCol_constr
The jacobian of the response function without taxon labels	JacCol_constr_noLab
Calculate the log-likelihoods of all possible models	liks
Get the value of the log-likelihood ratio of alpha	LR_nb
A function that returns the Jacobian of the likelihood ratio	LR_nb_Jac
Calculate the components of the influence functions	NBalphaInfl
The influence function for the column scores	NBcolInfl
Jacobian for the column components of the independence model	NBjacobianAbundsOld
Jacobian function for the estimation of a third degree GLM	NBjacobianColNP
Jacobian for the estimation of the column scores	NBjacobianColOld
Jacobian for the raw components of the independence model	NBjacobianLibSizes
Jacobian for the psi of a given dimension	NBjacobianPsi
A jacobian function of the NB for the row scores	NBjacobianRow
The influence function for the psis	NBpsiInfl
The influence function for the row scores	NBrowInfl
Perform a PERMANOVA analysis for group differences of a predefined cofactor using the pseudo F-statistic	permanova
Plot RC(M) ordination result with the help of ggplot2	plot.RCM
Plot the non-parametric response functions	plotRespFun
Wrapper function for the RCM() function	RCM RCM,matrix-method RCM,phyloseq-method
Fit the RC(M) model with the negative binomial distribution.	RCM_NB
Make residual plots	residualPlot
Calculates the Jacobian of the parametric response functions	respFunJacMat
Derivative of the Lagrangian of the parametric response function	respFunScoreMat
A function to efficiently row multiply a matrix and a vector	rowMultiply
A small auxiliary function for the length of the lambdas	seq_k
Trim based on confounders to avoid taxa with only zero counts	trimOnConfounders
Microbiomes of colorectal cancer patients and healthy controls	Zeller