MgnifyClient | R Documentation |
Constructor for creating a MgnifyClient object to allow the access to MGnify database.
A MgnifyClient object
MgnifyClient(
username = NULL,
password = NULL,
useCache = FALSE,
cacheDir = tempdir(),
showWarnings = FALSE,
verbose = TRUE,
clearCache = FALSE,
...
)
username |
A single character value specifying an optional username for
authentication. (By default: |
password |
A single character value specifying an optional password for
authentication. (By default: |
useCache |
A single boolean value specifying whether to enable on-disk
caching of results during this session. In most use cases should be TRUE.
(By default: |
cacheDir |
A single character value specifying a folder to contain the
local cache. Note that cached files are persistent, so the cache directory
may be reused between sessions, taking advantage of previously downloaded
results. The directory will be created if it doesn't exist already.
(By default: |
showWarnings |
A single boolean value specifying whether to print
warnings during invocation of some MGnifyR functions.
(By default: |
verbose |
A single boolean value specifying whether to print extra
output during invocation of some MGnifyR functions.
(By default: |
clearCache |
A single boolean value specifying whether to clear the
cache. (By default: |
... |
optional arguments:
|
All functions in the MGnifyR package take a MgnifyClient
object as
their first argument. The object allows the simple handling of both user
authentication and access to private data, and manages general options for
querying the MGnify database.
An object that are required by functions of MGnifyR package.
A MgnifyClient object.
databaseUrl
A single character value specifying an URL address of database.
authTok
A single character value specifying authentication token.
useCache
A single boolean value specifying whether to use cache.
cacheDir
A single character value specifying cache directory.
showWarnings
A single boolean value specifying whether to show warnings.
clearCache
A single boolean value specifying whether to clear cache.
verbose
A single boolean value specifying whether to show messages.
See MgnifyClient
for constructor.
See MgnifyClient-accessors
for accessor functions.
my_client <- MgnifyClient(
useCache = TRUE, cacheDir = "/scratch/MGnify_cache_location"
)
## Not run:
# Use username and password to get access to non-public data
my_client <- MgnifyClient(
username = "Webin-1122334", password = "SecretPassword",
useCache = TRUE, cacheDir = "/scratch/MGnify_cache_location"
)
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.