addStatusByRank: Add status by rank

Description Usage Arguments Value

View source: R/add_status.R

Description

Order the input data frame using a specific column and annotates the top N features.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
addStatusByRank(
  resDf,
  rankCol,
  topN,
  splitUpDown,
  decreasing = TRUE,
  absolute = TRUE,
  splitCol = "logFc",
  splitMidPoint = 0,
  noChangeLabel = "No change",
  statusCol = "status",
  upLabel = "Up",
  downLabel = "Down",
  sigLabel = "Significant"
)

Arguments

resDf

The data frame to annotate.

rankCol

The column used to order the data frame.

topN

The top N features to be annotated.

splitUpDown

Split annotation into up and down features? If TRUE, splitCol and splitMidPoint should be provided.

decreasing

Order rankCol decreasing?

absolute

Use absolute rankCol values?

splitCol

If splitUpDown = TRUE, the column used to split features into up and down.

splitMidPoint

If splitUpDown = TRUE, the splitCol value considered as midpoint.

noChangeLabel

Label to be used in not annotated rows.

statusCol

Name of the status column.

upLabel

Label for up-regulated features.

downLabel

Label for down-regulated features.

sigLabel

Label for significant features. Only used if splitUpDown = FALSE.

Value

The annotated data frame.


martingarrido/biokit documentation built on June 27, 2021, 2:21 a.m.