addResources

Share:

Description

Add resource metadata to a local ExperimentHub database

Usage

1
addResources(pathToPackage, insert = FALSE, ...)

Arguments

pathToPackage

Full path to data package including package name; no trailing slash.

insert

A logical to control if metadata are inserted in the ExperimentHub db. By default this option is FALSE which is a useful state in which to test a new recipe and confirm the metadata fields are correct.

When insert = TRUE, the "EXPERIMENT_HUB_SERVER_POST_URL" global option must be set to the http location of the ExperimentHubServer in the global environment or .Rprofile. This option controls Additionally, AWS command line tools must be installed on the local machine to push files to S3 buckets. See https://aws.amazon.com/cli/ for installation instructions.

...

TDB. Currently not used.

Details

When insert is TRUE, addResources attempts to add the metadata to the local database. A warning is thrown if duplicate files names are found in the local database or if any filenames in the new metadata match those in the existing database. Only metadata records with non-duplicated file names are added to the database. The file name is the name of the data file with the ‘rda’ extension.

Value

A list of ExperimentHubMetadata objects.

See Also

  • ExperimentHubMetadata

  • AnnotationHubMetadata

Examples

1
2
3
4
5
6
7
  ## Not run: 
    ## Generate metadata for inspection
    addResources("/home/vobencha/mypackage", insert=FALSE)
    ## Inset metadata into ExperimentHub database
    addResources("/home/vobencha/mypackage", insert=TRUE)
  
## End(Not run)