README.md

In UK-Digital-Heart-Project/mutools3D: Tools for Mass Univariate Analysis of 3D Phenotypes

mutools3D

The mutools3D package implements R functions for mass univariate analysis of three-dimensional phenotypes.

Installation

Currently this package is only available on GitHub and requires R (>= 3.3.2). For installation, the easiest way is using devtools. If you don’t have devtools installed, please start by typing:

install.packages("devtools")
library(devtools)

Then, to install the package just use install_githubfunction.

install_github("UK-Digital-Heart-Project/mutools3D", build_vignettes = TRUE)

Documentation

An introductory vignette is available from within R (and also here). Load the package and then use the vignette function:

library(mutools3D)
vignette("gettingStarted", package = "mutools3D")

The code has been fully documented and function descriptions are available from within R, i.e. help(mur).

Citation

Biffi C, de Marvao A, Attard MI, Dawes TJW, Whiffin N, Bai W, Shi W, Francis C, Meyer H, Buchan R, Cook SA, Rueckert D and O'Regan DP. Three-dimensional cardiovascular imaging-genetics: a mass univariate framework. Bioinformatics. 2018;34:97-103

UK-Digital-Heart-Project/mutools3D documentation built on April 7, 2024, 8:04 a.m.