getAnnotationHubOption {AnnotationHub} | R Documentation |
These functions get or set options for creation of new ‘AnnotationHub’ instances.
getAnnotationHubOption(arg) setAnnotationHubOption(arg, value)
arg |
The character(1) hub options to set. see ‘Details’ for current options. |
value |
The value to be assigned to the hub option. |
Supported options include:
character(1). The base URL of the annotation hub. Default: https://annotationhub.bioconductor.org
character(1). The location of the hub
cache. Default: “AnnotationHub” in the user's directory
established by rappdir::user_cache_dir
.
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.
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.
logical(1). TRUE/FALSE should the AnnotationHub
testing environment be used. AnnotationHub does automatic
filtering particularly with regards to OrgDbs. The
TESTING=TRUE
setting will allow for all OrgDbs for a given
devel version to also be displayed. (This option should really
only be set by a OrgDb contributing maintainer for testing and
debugging). Default: FALSE.
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.
The requested or successfully set option.
Martin Morgan mtmorgan@fhcrc.org and Lori Shepherd
getAnnotationHubOption("URL") ## Not run: setAnnotationHubOption("CACHE", "~/.myHub") ## End(Not run)