BiocSet-class: BiocSet class

Description Usage Arguments Value Slots Examples

Description

character()

The BiocSet constructor, the show method, the slot accessors, and creating a BiocSet object from an element set tibble rather than character vector(s).

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
BiocSet(..., metadata = list(), active = c("elementset", "element", "set"))

## S4 method for signature 'BiocSet'
show(object)

es_element(x)

## S4 method for signature 'BiocSet'
es_element(x)

es_set(x)

## S4 method for signature 'BiocSet'
es_set(x)

es_elementset(x)

## S4 method for signature 'BiocSet'
es_elementset(x)

BiocSet_from_elementset(elementset, element, set, metadata)

Arguments

...

Named character() vectors of element sets, or a named list of character() vectors. Each character vector is an element set. The names of the character vectors are the names of the sets.

metadata

A list() with arbitrary content, describing the set.

active

A character(1) to indicate which tibble is active. The default is "elementset".

object

A BiocSet object.

x

A BiocSet object.

elementset

A tibble with element set information.

element

A tibble with element information.

set

A tibble with set information.

Value

An S4 BiocSet object shown as a tripple tibble, where each slot is a tibble.

Slots

element

The element tibble from 'tbl_elementset'

set

The set tibble from 'tbl_elementset'

elementset

The elementset tibble created from user input

active

A character(1), indicates which tibble is active

metadata

A list() with arbitrary elements describing the set

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
BiocSet(set1 = letters, set2 = LETTERS)
lst <- list(set1 = letters, set2 = LETTERS)
BiocSet(lst)

set.seed(123)
element <-
   tibble(
       element = letters[1:10],
       v1 = sample(10),
       v2 = sample(10)
   )
set <-
   tibble(
       set = LETTERS[1:2],
       v1 = sample(2),
       v2 = sample(2)
   )
elementset <-
   tibble(
       element = letters[1:10],
       set = sample(LETTERS[1:2], 10, TRUE)
   )
BiocSet_from_elementset(elementset, element, set)

BiocSet documentation built on Nov. 8, 2020, 7:48 p.m.