new.experiment: New R-API MaveDB Experiment

In jweile/rapimave: R API for MaveDB

Description

Internal constructor that creates an immutable new Experiment object. This function is not exported and should not be called outside of the rapimave package itself. Experiment objects are generated by the getAllExperiments() and getExperiment() methods of a rapimave object (which itself is generated using the new.rapimave() constructor). However, this section explains the functions that are available for these objects.

Usage

new.experiment(data)

Details

A Experiment object offers the following getter functions:

• getContributors() returns a list of users that contributed to this record.

• getURN() returns the URN of this record.

• getCreationDate() returns the date when this record was originally created.

• getModificationDate() returns the date when this record was last modified.

• getPublicationDate() returns the date when this record was published.

• getCreatedBy() returns the user who originally created this record.

• getModifiedBy() returns the user who last modified this record.

• getMetadata() returns the metadata for this record.

• getTitle() returns the title of this record.

• getShortDescription() returns a short description text of this record.

• getAbstract() returns the abstract text of this record.

• getMethods() returns the methods description text of this record.

• getKeywords() returns the list of keywords associated with this record.

• getDOIs() returns the list of Digital Object Identifiers (DOIs) associated with this record.

• getXrefSRA() returns cross-references to the NCBI Short Read Archive (SRA).

• getXRefPubmed() returns cross-references to Pubmed.

• getExperimentSet() return the accession of the ExperimentSet to which this Experiment belongs.

• getScoreSets() return the list of URNs of the Experiment's ScoreSets.

Value

a new R-API MaveDB experiment object.

Examples

## Not run: 
mave <- new.rapimave()
exp1 <- mave$getExperiment("urn:mavedb:00000001-a")
authorIds <- exp1$getAuthors()

## End(Not run)

jweile/rapimave documentation built on Aug. 4, 2021, 12:12 a.m.