Diff of /man/rankFeatures.Rd [000000] .. [72a7c3]

Switch to unified view

a b/man/rankFeatures.Rd
1
% Generated by roxygen2: do not edit by hand
2
% Please edit documentation in R/feature_processing.R
3
\name{rankFeatures}
4
\alias{rankFeatures}
5
\title{Pre-rank features prior to calculating enrichment scores.}
6
\usage{
7
rankFeatures(logFC, pvalues, base = 10)
8
}
9
\arguments{
10
\item{logFC}{Vector containing the log-transformed fold changes of features.}
11
12
\item{pvalues}{Vector containing the p-values associated with those logFCs.}
13
14
\item{base}{Integer specifying the base of the logarithm. Default: 10}
15
}
16
\value{
17
Vector of pre-ranked features, still unsorted
18
}
19
\description{
20
Rank features based on the direction of their fold change and their magnitude
21
implicated through their assigned p-value.
22
}
23
\examples{
24
logFC <- rnorm(10)
25
pvalues <- runif(10)
26
rankFeatures(logFC, pvalues)
27
28
}