-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathcalcBocklandt.Rd
26 lines (23 loc) · 1.27 KB
/
calcBocklandt.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/calcBocklandt.R
\name{calcBocklandt}
\alias{calcBocklandt}
\title{calcBocklandt}
\usage{
calcBocklandt(DNAm, pheno = NULL, CpGImputation = NULL, imputation = F)
}
\arguments{
\item{DNAm}{a matrix of methylation beta values. Needs to be rows = samples and columns = CpGs, with rownames and colnames.}
\item{pheno}{Optional: The sample phenotype data (also with samples as rows) that the clock will be appended to.}
\item{CpGImputation}{An optional namesd vector for the mean value of each CpG that will be input from another dataset if such values are missing here (from sample cleaning)}
\item{imputation}{Logical value that will allows you to perform (T)/ skip (F) imputation of mean values for missing CpGs. Warning: when imputation = F if there are missing CpGs, it will automatically ignore these CpGs during calculation, making the clock values less accurate.}
}
\value{
If you added the optional pheno input (preferred) the function appends a column with the clock calculation and returns the dataframe. Otherwise, it will return a vector of calculated clock values in order of the
}
\description{
A function to calculate the Bocklandt clock.
}
\examples{
calcBocklandt(exampleBetas, examplePheno, imputation = F)
}