gofigR1.1.3 package

Client for 'GoFigr.io'

asset_linked_to_figure

Creates an object representing a relationship between a figure and an ...

authenticate_jwt

Performs JWT authentication with username and password. Saves tokens i...

calc_checksum

Calculates a checksum for a file

cat.gofigr_revision

Default cat method for GoFigr revisions.

check_configured

Checks whether GoFigr has been correctly configured.

CONFIG_PATH

Default path to the config file

create_analysis

Create a new analysis within a workspace.

create_api_key

Creates a new API key. This function will only succeed if using passwo...

create_asset_revision

Creates a new asset revision

create_asset

Creates a new asset

create_figure

Create a new figure under an analysis.

create_ggsave_args

Creates a list of arguments for ggplot2::ggsave() with optional dimens...

create_revision

Creates a new revision

create_workspace

Create 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

delete_analysis

Delete an analysis by API ID.

enable

Enables GoFigr in the current R/Rmd file.

encode_raw_data

Converts a GoFigr data object into R primitives that can be converted ...

find_analysis

Find an analysis by name, optionally creating it.

find_asset_by_name

Finds an asset by name

find_asset_revision_by_hash

Finds all asset revisions with a matching hash digest

find_config

Finds the .gofigr config file in current directory or any of the paren...

find_figure

Find a figure by name within an analysis.

find_workspace

Find a workspace by name, optionally creating it.

get_analysis

Fetch an analysis by API ID.

get_api_id

Returns obj$api_id if argument is an object, or identity if it's a str...

get_asset_revision

Gets an asset revision given an API ID

get_asset

Fetches an asset given an API ID.

get_client

Gets the currently configured GoFigr client

get_data

Retrieves a data object. Use in conjunction with get_revision or get_a...

get_execution_context

Gets the execution context: input path, chunk code, and other metadata...

get_figure

Fetch a single figure by API ID.

get_options

Gets configured GoFigr options.

get_qr_png

Generates a QR code and converts it into an img element.

get_revision_url

Gets the full URL for a revision

get_revision

Fetches a revision given an API ID.

get_title

Gets a title from a plot

get_workspace

Retrieve workspace details.

gf_plot

Plots and publishes an object (if supported)

gf_print

Prints and publishes an object (if supported)

gfconfig

Interactive configuration helper for the GoFigr R client.

gfContainer

Generates a div container for the GoFigr widget.

gfPlot

Defines a GoFigr plot area.

gfPlotServer

Creates a Shiny component to handle plotting and publishing. Has to be...

ggwatermark

Applies a watermark to a plot object/function.

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 u...

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 a...

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

Resolve the workspace argument, falling back to the client's default.

intercept

Wraps a plotting function (e.g. plot) so that its output is intercepte...

is_expired_token

Returns True if the response indicates an expired JWT token

is_intercept_on

Checks whether GoFigr intercept is on

LINK_WATERMARK

Draws a watermark with just a GoFigr link

list_analyses

List analyses within a workspace.

list_workspaces

List all workspaces available to the authenticated user.

login_with_api_key

Prompts the user for an API key or interactively creates a new one.

login_with_username

Prompts the user for username and 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

new_asset_revision_from_file

Creates a new asset revision from file.

NO_WATERMARK

Does not draw any watermarks.

print.gofigr_revision

Default print method for GoFigr revisions.

print.gofigr

Default print method for a GoFigr client.

publish_base

Captures output from grid graphics (ggplot2, lattice, ComplexHeatmap, ...

publish

Publishes a figure to the GoFigr service.

QR_WATERMARK

Draws a watermark with a GoFigr link and a QR code

read_config

Reads the GoFigr configuration, prioritizing environment variables ove...

read_csv

Syncs a file with the GoFigr service and stores a reference. The file ...

read_csv2

Syncs a file with the GoFigr service and stores a reference. The file ...

read_delim

Syncs a file with the GoFigr service and stores a reference. The file ...

read_prompt

Reads a line from stdin with optional validation and retry logic.

read_tsv

Syncs a file with the GoFigr service and stores a reference. The file ...

read.csv

Syncs a file with the GoFigr service and stores a reference. The file ...

read.csv2

Syncs a file with the GoFigr service and stores a reference. The file ...

read.xlsx

Syncs a file with the GoFigr service and stores a reference. The file ...

refresh_jwt

Refreshes the JWT access token. Attempts re-authentication if refresh ...

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.

sync_file

Syncs a file with the GoFigr service and stores a reference. The file ...

sync_workspace_asset

Syncs a file with the GoFigr service

try_base2grob

Tries to convert expression to a grob, returning it unchanged if it fa...

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(waterm...

with_isolated_devices

Executes an expression while isolating any new graphics devices it cre...

Integrates with your 'RMarkdown' documents to automatically publish figures to the <https://GoFigr.io> service. Supports both 'knitr' and interactive execution within 'RStudio'.

  • Maintainer: Maciej Pacula
  • License: MIT + file LICENSE
  • Last published: 2025-11-26