CAN_data {hidecan}

Creates a CAN_data object

Description

Creates a CAN_data object from a tibble or data-frame of candidate genes.

Usage

CAN_data(dat, keep_rownames_as = NULL)

Arguments

dat

Tibble, set of candidate genes of interest. See Details.

keep_rownames_as

Character, the name of the column in which to save the rownames of the input data-frame. Default value is NULL, i.e. rownames will be discarded.

Details

The input data should have one row per gene, and at least the following columns:

• chromosome: character column, chromosome on which the gene is located.

• start and end: numeric, starting and end position of the gene (in bp). A column position will be constructed as the middle value (mean) between start and end.

• name: character, the name of the candidate genes to be displayed.

Value

A CAN_data object, i.e. a tibble.

Examples

x <- get_example_data()

CAN_data(x[["CAN"]])