| Creates an object representing a relationship between a figure and an asset. | asset_linked_to_figure |
| Performs JWT authentication with username and password. Saves tokens in the GoFigr client. | authenticate_jwt |
| Calculates a checksum for a file | calc_checksum |
| Default cat method for GoFigr revisions. | cat.gofigr_revision |
| Check total DataFrame size against MAX_CLEAN_ROOM_BYTES. Returns a list with $ok (logical) and $total_bytes. | check_clean_room_size |
| Checks whether GoFigr has been correctly configured. | check_configured |
| Creates a checkbox parameter for use in 'reproducible' functions. | checkbox |
| Default path to the config file | CONFIG_PATH |
| Create a new analysis within a workspace. | create_analysis |
| Creates a new API key. This function will only succeed if using password authentication. | create_api_key |
| Creates a new asset | create_asset |
| Creates a new asset revision | create_asset_revision |
| Create a new figure under an analysis. | create_figure |
| Creates a list of arguments for ggplot2::ggsave() with optional dimension and DPI parameters. | create_ggsave_args |
| Creates a new revision | create_revision |
| Creates a new revision via the auto-assign endpoint. | create_revision_auto_assign |
| Create a new workspace. | create_workspace |
| List of data types supported by GoFigr | DATA_TYPES |
| Returns a default value if argument is null or empty | default_if_null |
| Delete an analysis by API ID. | delete_analysis |
| Creates a dropdown parameter for use in 'reproducible' functions. | dropdown |
| Enables GoFigr in the current R/Rmd file. | enable |
| Converts a GoFigr data object into R primitives that can be converted to JSON, performing base64 encoding of binary data. | encode_raw_data |
| Find an analysis by name, optionally creating it. | find_analysis |
| Finds an asset by name | find_asset_by_name |
| Finds all asset revisions with a matching hash digest | find_asset_revision_by_hash |
| Finds the .gofigr config file in current directory or any of the parent directories. If the file cannot be found, will also check CONFIG_PATH. | find_config |
| Find a figure by name within an analysis. | find_figure |
| Find a workspace by name, optionally creating it. | find_workspace |
| Fetch an analysis by API ID. | get_analysis |
| Returns obj$api_id if argument is an object, or identity if it's a string. | get_api_id |
| Resolves the short-redirect URL used for watermark/QR code links. Returns the bare "gofigr.io" domain (without app. prefix) so the resulting URLs and QR codes are as compact as possible. | get_app_short_url |
| Resolves the app (frontend) URL from a GoFigr client's API base URL. Used for full app links (asset URLs, "View on GoFigr" links, etc). For watermark/QR code URLs, use 'get_app_short_url' instead. | get_app_url |
| Fetches an asset given an API ID. | get_asset |
| Gets an asset revision given an API ID | get_asset_revision |
| Fetches Auth0 configuration from the server's /info endpoint. | get_auth0_config |
| Gets the currently configured GoFigr client | get_client |
| Retrieves a data object. Use in conjunction with get_revision or get_asset_revision, to retrieve the full data for a data object. | get_data |
| Gets the execution context: input path, chunk code, and other metadata. | get_execution_context |
| Fetch a single figure by API ID. | get_figure |
| Gets configured GoFigr options. | get_options |
| Generates a QR code and converts it into an img element. | get_qr_png |
| Fetches a revision given an API ID. | get_revision |
| Gets the full URL for a revision | get_revision_url |
| Gets a title from a plot | get_title |
| Retrieve workspace details. | get_workspace |
| Plots and publishes an object (if supported) | gf_plot |
| Prints and publishes an object (if supported) | gf_print |
| Interactive configuration helper for the GoFigr R client. | gfconfig |
| Generates a div container for the GoFigr widget. | gfContainer |
| Defines a GoFigr plot area. | gfPlot |
| Creates a Shiny component to handle plotting and publishing. Has to be paired with a gfPlot element in the UI. | gfPlotServer |
| Applies a watermark to a plot object/function. | ggwatermark |
| Equivalent to cat but only outputs if GoFigr client is verbose. | gofigr_cat |
| Creates and configures a GoFigr client. You can login either using a username & password or an API key. See examples. | gofigr_client |
| Wrapper for httr::DELETE that automatically handles authentication. | gofigr_DELETE |
| Wrapper for httr::GET that automatically handles authentication. | gofigr_GET |
| Wraps an HTTR method e.g. GET to provide relative URL resolution and authentication | gofigr_make_handler |
| Wrapper for httr::PATCH that automatically handles authentication. | gofigr_PATCH |
| Wrapper for httr::POST that automatically handles authentication. | gofigr_POST |
| Wrapper for httr::PUT that automatically handles authentication. | gofigr_PUT |
| Resolve the workspace argument, falling back to the client's default. | infer_workspace |
| Wraps a plotting function (e.g. plot) so that its output is intercepted by GoFigr. | intercept |
| Returns True if the response indicates an expired JWT token | is_expired_token |
| Checks whether GoFigr intercept is on | is_intercept_on |
| Check whether a value is serializable for clean room storage. | is_serializable |
| Draws a watermark with just a GoFigr link | LINK_WATERMARK |
| List analyses within a workspace. | list_analyses |
| Lists all active GoFigr sessions. | list_sessions |
| List all workspaces available to the authenticated user. | list_workspaces |
| Prompts the user for an API key or interactively creates a new one. | login_with_api_key |
| Authenticates via Auth0 Device Authorization Flow. | login_with_device_flow |
| Creates a GoFigr data object storing source code | make_code_data |
| Creates a GoFigr data object storing file data | make_file_data |
| Creates a GoFigr data object storing image data | make_image_data |
| Creates a GoFigr data object which can be attached to revisions. | make_raw_data |
| Creates a GoFigr data object storing data.frame/tabular data | make_table_data |
| Creates a GoFigr data object to store text | make_text_data |
| Creates a new asset revision from file. | new_asset_revision_from_file |
| Does not draw any watermarks. | NO_WATERMARK |
| Build a Shiny input widget from a gf_param descriptor. | param_to_shiny_input |
| Default print method for a GoFigr client. | print.gofigr |
| Default print method for GoFigr revisions. | print.gofigr_revision |
| Publishes a figure to the GoFigr service. | publish |
| Captures output from grid graphics (ggplot2, lattice, ComplexHeatmap, etc.) and publishes it to GoFigr. | publish_base |
| Draws a watermark with a GoFigr link and a QR code | QR_WATERMARK |
| Reads the GoFigr configuration, prioritizing environment variables over the config file: | read_config |
| Syncs a file with the GoFigr service and stores a reference. The file will be associated with all figures published after this call. | read_csv |
| Syncs a file with the GoFigr service and stores a reference. The file will be associated with all figures published after this call. | read_csv2 |
| Syncs a file with the GoFigr service and stores a reference. The file will be associated with all figures published after this call. | read_delim |
| Reads a line from stdin with optional validation and retry logic. | read_prompt |
| Syncs a file with the GoFigr service and stores a reference. The file will be associated with all figures published after this call. | read_tsv |
| Syncs a file with the GoFigr service and stores a reference. The file will be associated with all figures published after this call. | read.csv |
| Syncs a file with the GoFigr service and stores a reference. The file will be associated with all figures published after this call. | read.csv2 |
| Syncs a file with the GoFigr service and stores a reference. The file will be associated with all figures published after this call. | read.xlsx |
| Refreshes the JWT access token. Attempts re-authentication if refresh fails. | refresh_jwt |
| Execute a function in a clean room environment and publish with full reproducibility metadata. | reproducible |
| Reserve a short ID prefix from the GoFigr server. | reserve_short_id_prefix |
| Convenience function for parsing JSON from httr responses | response_to_JSON |
| Round-trip parameters through serialization to ensure what the function sees matches what will be stored. DataFrames go through Parquet; other values go through JSON. | round_trip_params |
| Run the Shiny gadget for interactive clean room exploration. | run_reproducible_gadget |
| Returns cached server info from the /info/ endpoint. | server_info |
| Sets GoFigr options. | set_options |
| Creates a slider parameter for use in 'reproducible' functions. | slider |
| Stacks images horizontally, centering them vertically. | stack_horizontally |
| Stacks images vertically, centering them horizontally. | stack_vertically |
| Creates a static (read-only) parameter for use in 'reproducible' functions. | static |
| Suppresses any automatic GoFigr publication hooks. | suppress |
| Syncs a file with the GoFigr service and stores a reference. The file will be associated with all figures published after this call. | sync_file |
| Syncs a file with the GoFigr service | sync_workspace_asset |
| Creates a text input parameter for use in 'reproducible' functions. | text_input |
| Tries to convert expression to a grob, returning it unchanged if it fails. | try_base2grob |
| Updates data associated with a figure | update_revision_data |
| Fetches user details for the currently logged in user. | user_info |
| Validate that all parameters are serializable for clean room storage. Returns a list with $valid (logical) and $errors (character vector of messages). | validate_params |
| Makes a watermark generator. You can use the result with enable(watermark=...). | watermark_generator |
| Executes an expression while isolating any new graphics devices it creates. | with_isolated_devices |
