DatasetInfo: BioMart Dataset Information Class

In bhklab/AnnotationGx: AnnotationGx: A package for building, updating and querying an annotation database for pharmaco-genomic data

BioMart Dataset Information Class

Description

Class that stores information about a dataset within a BioMart database.

Details

This class encapsulates metadata about a specific dataset in a BioMart database, including its name, description, display name, and a reference to the parent mart.

Public fields

name

The internal name of the dataset

description

A textual description of the dataset

displayName

The human-readable name of the dataset

mart

The MartInfo object this dataset belongs to

Methods

Public methods

• DatasetInfo$new()

• DatasetInfo$print()

• DatasetInfo$clone()

---

Method new()

Initialize a new DatasetInfo object

Usage

DatasetInfo$new(name, description, displayName, mart)

Arguments

name

Character, the internal name of the dataset

description

Character, the dataset description

displayName

Character, the human-readable name

mart

MartInfo object, the parent mart

Returns

A new DatasetInfo object

---

Method print()

Print method for DatasetInfo objects

Usage

DatasetInfo$print(...)

Arguments

...

Additional arguments (not used)

Returns

Invisibly returns self

---

Method clone()

The objects of this class are cloneable with this method.

Usage

DatasetInfo$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

bhklab/AnnotationGx documentation built on April 3, 2025, 4:27 p.m.