hyp: A hyp object

In montilab/hypeR: An R Package For Geneset Enrichment Workflows

A hyp object

Description

A hyp object

A hyp object

See Also

multihyp

Public fields

data

A dataframe returned by hypeR()

plots

A list of plots returned by hypeR()

args

A list of arguments passed to hypeR()

info

Exported information for reproducibility

Methods

Public methods

• hyp$new()

• hyp$print()

• hyp$as.data.frame()

• hyp$clone()

---

Method new()

Create a hyp object

Usage

hyp$new(data, plots = NULL, args = NULL, info = NULL)

Arguments

data

A dataframe returned by hypeR()

plots

A list of plots returned by hypeR()

args

A list of arguments passed to hypeR()

info

Exported information for reproducibility

Returns

A new hyp object

---

Method print()

Print hyp obect

Usage

hyp$print()

Returns

NULL

---

Method as.data.frame()

Extract dataframe from hyp obect

Usage

hyp$as.data.frame()

Returns

NULL

---

Method clone()

The objects of this class are cloneable with this method.

Usage

hyp$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

data <- data.frame(replicate(5,sample(0:1,10,rep=TRUE)))
args <- list("arg_1"=1, "arg_2"=2, "arg_3"=3)
hyp_obj <- hyp$new(data, args=args)

montilab/hypeR documentation built on Oct. 29, 2023, 12:01 p.m.