getAnnotationHubOption: Get and set options for default AnnotationHub behavior.

Description

These functions get or set options for creation of new ‘AnnotationHub’ instances.

Usage

getAnnotationHubOption(arg)
setAnnotationHubOption(arg, value)

Arguments

arg

The character(1) hub options to set. see ‘Details’ for current options.

value

The value to be assigned to the hub option.

Value

Details

Supported options include:

“URL”:

character(1). The base URL of the annotation hub. Default: https://annotationhub.bioconductor.org

“CACHE”:

character(1). The location of the hub cache. Default: “.AnnotationHub” in the user home directory.

“MAX_DOWNLOADS”:

numeric(1). The integer number of downloads allowed before triggering an error. This is to help avoid accidental download of a large number of AnnotationHub members.

“PROXY”:

request object returned by httr::use_proxy(). The request object describes a proxy connection allowing Internet access, usually through a restrictive firewall. Setting this option sends all AnnotationHub requests through the proxy. Default: NULL.

In setHubOption("PROXY", value), value can be one of NULL, a request object returned by httr::use_proxy(), or a well-formed URL as character(1). The URL can be completely specified by http://username:password@proxy.dom.com:8080; username:password and port (e.g. :8080) are optional.

Default values may also be determined by system and global R environment variables visible before the package is loaded. Use options or variables preceeded by “ANNOTATION_HUB_”, e.g., options(ANNOTATION_HUB_MAX_DOWNLOADS=10) prior to package load sets the default number of downloads to 10.

Examples

Run this code

getAnnotationHubOption("URL")
## Not run: 
# setAnnotationHubOption("CACHE", "~/.myHub")
# ## End(Not run)

Run the code above in your browser using DataLab