Client for 'GoFigr.io'

[Up] [Top]

Documentation for package ‘gofigR’ version 0.2.2

Help Pages

authenticate_jwt Performs JWT authentication with username and password. Saves tokens in the GoFigr client.
capture Captures output of an expression and publishes it to GoFigr. This function is helpful if you have multiple function calls which incrementally build a single figure.
create_analysis Creates a new analysis
create_api_key Creates a new API key. This function will only succeed if using password authentication.
create_figure Creates a new figure. The created figure will be blank and won't contain any revisions.
create_revision Creates a new revision
create_workspace Creates a new workspace
DATA_TYPES List of data types supported by GoFigr
default_if_null Returns a default value if argument is null or empty
enable Enables GoFigr support.
encode_raw_data Converts a GoFigr data object into R primitives that can be converted to JSON, performing base64 encoding of binary data.
find_analysis Finds an analysis by name, optionally creating one if it doesn't exist.
find_figure Finds a figure by name
find_workspace Finds a workspace by name, optionally creating it if doesn't exist
get_analysis Fetches an analysis given an API ID.
get_api_id Returns obj$api_id if argument is an object, or identity if it's a string.
get_figure Fetches a figure given an API ID.
get_options Gets configured GoFigr options.
get_revision Fetches a revision given an API ID.
get_revision_url Gets the full URL for a revision
get_workspace Retrieves workspace details.
gfconfig Configures gofigr for use on this machine. Saves configuration to ~/.gofigr.
gf_plot Plots and publishes an object (if supported)
gf_print Prints and publishes an object (if supported)
gofigr_cat Equivalent to cat but only outputs if GoFigr client is verbose.
gofigr_client Creates and configures a GoFigr client. You can login either using a username & password or an API key. See examples.
gofigr_DELETE Wrapper for httr::DELETE that automatically handles authentication.
gofigr_GET Wrapper for httr::GET that automatically handles authentication.
gofigr_make_handler Wraps an HTTR method e.g. GET to provide relative URL resolution and authentication
gofigr_PATCH Wrapper for httr::PATCH that automatically handles authentication.
gofigr_POST Wrapper for httr::POST that automatically handles authentication.
gofigr_PUT Wrapper for httr::PUT that automatically handles authentication.
infer_workspace Returns the argument if a valid workspace is passed, or the default workspace from the GoFigr client otherwise. Throws an error if both are NULL.
intercept Wraps a plotting function (e.g. heatmap.2) so that its output is intercepted by GoFigr.
is_expired_token Returns True if the response indicates an expired JWT token
LINK_WATERMARK Draws a watermark with just a GoFigr link
list_analyses Lists analyses under a workspace.
list_workspaces List all workspaces available to the user.
login_with_api_key Prompts the user for an API key or creates a new one
login_with_username Prompts the user for username & password and logs into GoFigr
make_code_data Creates a GoFigr data object storing source code
make_file_data Creates a GoFigr data object storing file data
make_image_data Creates a GoFigr data object storing image data
make_raw_data Creates a GoFigr data object which can be attached to revisions.
make_table_data Creates a GoFigr data object storing data.frame/tabular data
make_text_data Creates a GoFigr data object to store text
NO_WATERMARK Does not draw any watermarks.
plot_interactive Replacement for plot in an interactive session outside of RStudio (e.g. terminal). Captures the plot and publishes to GoFigr.
plot_knitr Replacement for plot() in a knitr context. Captures the plot and publishes it to GoFigr.
plot_rstudio Replacement for plot within RStudio. Captures the plot and publishes to GoFigr.
plot_script Replacement for plot in a script. Captures the plot and publishes to GoFigr.
print.gofigr Default print method for a GoFigr client.
print.gofigrdata Default print representation of GoFigr data objects.
QR_WATERMARK Draws a watermark with a GoFigr link and a QR code
read_config Reads the GoFigr configuration, prioritizing environment variables over the config file:
read_prompt Reads a prompt from stdin and performs optional validation
refresh_jwt Refreshes the JWT access token. Attempts re-authentication if refresh fails.
response_to_JSON Convenience function for parsing JSON from httr responses
set_options Sets GoFigr options.
stack_horizontally Stacks images horizontally, centering them vertically.
stack_vertically Stacks images vertically, centering them horizontally.
suppress Suppresses any automatic GoFigr publication hooks.
update_revision_data Updates data associated with a figure
user_info Fetches user details for the currently logged in user.
watermark_generator Makes a watermark generator. You can use the result with enable(watermark=...).