Title: | Orderly Support for 'OrderlyWeb' |
---|---|
Description: | Client for 'OrderlyWeb' for use from the 'orderly' package. Allows downloading of reports, running remote reports and other interaction with the remote report repository. |
Authors: | Rich FitzJohn [aut, cre], Imperial College of Science, Technology and Medicine [cph] |
Maintainer: | Rich FitzJohn <[email protected]> |
License: | MIT + file LICENSE |
Version: | 0.1.15 |
Built: | 2024-12-05 04:42:12 UTC |
Source: | https://github.com/vimc/orderlyweb |
Create an orderlyweb object, for interaction with the OrderlyWeb
API at a high level. For low level access, see
orderlyweb_api_client
or the $api_client
field of the created object.
orderlyweb(..., api_client = NULL)
orderlyweb(..., api_client = NULL)
... |
Arguments passed through to
|
api_client |
A pre-constructed
|
cl <- orderlyweb::orderlyweb(host = "example.com", port = 443, token = "mytoken") cl$api_client$is_authorised()
cl <- orderlyweb::orderlyweb(host = "example.com", port = 443, token = "mytoken") cl$api_client$is_authorised()
Create a low-level HTTP API client for use with OrderlyWeb.
orderlyweb_api_client(host, port, token, name = NULL, https = TRUE, prefix = NULL, api_version = 2, insecure = FALSE, verbose = FALSE)
orderlyweb_api_client(host, port, token, name = NULL, https = TRUE, prefix = NULL, api_version = 2, insecure = FALSE, verbose = FALSE)
host |
Fully qualified hostname for the OrderlyWeb instance |
port |
Port to use |
token |
Your application token for authentication. The appropriate value here will depend on the authentication support that is built into the OrderlyWeb server that you are communicating with. Provide the token directly (as a string) or provide a callback function that takes no arguments and returns token. |
name |
A friendly name for the server (e.g, "production" or
"testing") which may be printed when using the remote, or when
authenticating. If not provided then a name will be constructed
from |
https |
Optional logical, indicating if this is an https
connection - this should be |
prefix |
A prefix, if your OrderlyWeb server is mounted at a path within some larger website. |
api_version |
The API version to request - this should be left as 2. |
insecure |
Avoid SSL certificate testing - this is completely insecure (as bad as http) and exists only for testing. |
verbose |
Be verbose in all http exchanges. This will be very noisy. |
cl <- orderlyweb::orderlyweb_api_client(host = "example.com", port = 443, token = "mytoken") cl$is_authorised()
cl <- orderlyweb::orderlyweb_api_client(host = "example.com", port = 443, token = "mytoken") cl$is_authorised()
Implements an orderly "remote" using OrderlyWeb as a backend. Use
this within an orderly_config.yml
configuration.
orderlyweb_remote(host, port, token, https = TRUE, prefix = NULL, name = NULL)
orderlyweb_remote(host, port, token, https = TRUE, prefix = NULL, name = NULL)
host |
Fully qualified hostname for the OrderlyWeb instance |
port |
Port to use |
token |
Your application token for authentication. The appropriate value here will depend on the authentication support that is built into the OrderlyWeb server that you are communicating with. Provide the token directly (as a string) or provide a callback function that takes no arguments and returns token. |
https |
Optional logical, indicating if this is an https
connection - this should be |
prefix |
A prefix, if your OrderlyWeb server is mounted at a path within some larger website. |
name |
A friendly name for the server (e.g, "production" or
"testing") which may be printed when using the remote, or when
authenticating. If not provided then a name will be constructed
from |
remote <- orderlyweb::orderlyweb_remote("example.com", 443, "mytoken") remote
remote <- orderlyweb::orderlyweb_remote("example.com", 443, "mytoken") remote