Class ExperimentHubMetadata objects and methods

Share:

Description

ExperimentHubMetadata is used to represent record(s) in the server data base.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
ExperimentHubMetadata(ExperimentHubRoot=NA_character_, 
        BiocVersion=biocVersion(),
        SourceUrl=NA_character_, 
        SourceType=NA_character_, 
        SourceVersion=NA_character_, 
        SourceLastModifiedDate=as.POSIXct(NA_character_), 
        SourceMd5=NA_character_, 
        SourceSize=NA_real_,
        DataProvider=NA_character_, 
        Title=NA_character_, 
        Description=NA_character_,
        Maintainer=NA_character_, 
        Species=NA_character_, 
        TaxonomyId=NA_integer_, 
        Genome=NA_character_, 
        Tags=NA_character_,
        RDataClass=NA_character_, 
        RDataDateAdded=as.POSIXct(NA_character_),
        RDataPath=NA_character_,
        Coordinate_1_based=TRUE,
        Notes=NA_character_,
        DispatchClass=NA_character_,
        PreparerClass=NA_character_,
        Location_Prefix='http://s3.amazonaws.com/experimenthub/')

Arguments

ExperimentHubRoot

character(1) Prefix of the local path to resources to be added to ExperimentHub. Currently not used.

SourceUrl

character(1) TBD

SourceType

character(1) TBD

SourceVersion

character(1) TBD

SourceLastModifiedDate

POSIXct() Date when resource was last modified

SourceMd5

character(1) md5 hash of original file

SourceSize

numeric(1) Number of bytes in original file

DataProvider

character(1) Original data provider

Title

character(1) Title for this resource

Description

character(1) Description of the resource

Species

character(1) Species name

TaxonomyId

character(1) NCBI code

Genome

character(1) Name of genome build

Tags

character() Free-form tags for search. biocViews from DESCRIPTION are added to the Tags.

RDataClass

character(1) Class of derived object (e.g. ‘GRanges’)

RDataDateAdded

POSIXct() Date added to ExperimentHub; used to determine snapshots.

RDataPath

character(1) file path to serialized form

Maintainer

character(1) Maintainer name and email address, ‘A Maintainer a.maintainer@email.addr

BiocVersion

character() Under which resource was built

Coordinate_1_based

logical(1) Do coordinates start with 1 or 0?

Location_Prefix

character(1) URL location of AWS S3 bucket.

Notes

character() Notes about the resource.

DispatchClass

character(1) Used internally.

PreparerClass

character(1) Used internally.

Details

Instances of this class are generated by a call to addResources.

Value

A ExperimentHubMetadata object.

See Also

  • addResources

  • ExperimentHub

Examples

1
## TODO