Package 'connectwidgets'

Description

Returns content items owned by the specified user(s) (by username)

Usage

by_owners(content, usernames)

by_owner(content, usernames)

Arguments

Value

The filtered content data frame

Description

Returns content items that have the specified tag(s) (by tag name)

Usage

by_tags(content, tagnames)

by_tag(content, tagnames)

Arguments

Value

The filtered content data frame

Description

Class representing a Connect API client

Class representing a Connect API client

Details

This class allows a user to interact with a Connect server via the Connect API. Authentication is done by providing an API key.

Methods

Public methods

• Client$new()

• Client$print()

• Client$GET()

• Client$content()

• Client$server_settings()

• Client$clone()

Method new()

Usage

Client$new(server, api_key)

Method print()

Usage

Client$print(...)

Method GET()

Usage

Client$GET(path, ..., writer = httr::write_memory(), parser = "text")

Method content()

Usage

Client$content()

Method server_settings()

Usage

Client$server_settings()

Method clone()

The objects of this class are cloneable with this method.

Usage

Client$clone(deep = FALSE)

Arguments

Description

Creates a connection to Posit Connect using the server URL and an api key.

Usage

connect(
  server = Sys.getenv("CONNECT_SERVER", NA_character_),
  api_key = Sys.getenv("CONNECT_API_KEY", NA_character_)
)

Arguments

Value

An Client object

Description

connectwidgets provides UI components to help publishers provide curated organization of content on Posit Connect.

Connection

Set CONNECT_SERVER and CONNECT_API_KEY environment variables and connect(). Fetch a tibble listing server content with content(). Use the by_owner() and by_tags() filter helpers to narrow your search.

Components

Present your content with different components:

• rsc_card() for highlighting individual content items

• rsc_grid() for groups of cards

• rsc_table() for a tabular view

• rsc_search() a text input for searching grids and tables

• rsc_filter() an input to filter grids or tables by owner, type, or tag

Author(s)

Maintainer: Brian Smith [email protected]

Authors:

• Marcos Navarro [email protected]

Other contributors:

• David Aja [email protected] [contributor]

• Kelly O'Briant [email protected] [contributor]

• Posit [copyright holder]

See Also

Useful links:

• https://rstudio.github.io/connectwidgets/

• https://github.com/rstudio/connectwidgets

• Report bugs at https://github.com/rstudio/connectwidgets/issues

Description

Returns content items as a data frame from the Connect server. It will only return content that is visible to the API key's user account.

Usage

content(client, unpublished = FALSE)

Arguments

Value

A data frame (tibble) of content items

• id - Auto-incrementing identifier for each content item (legacy)

• guid - Unique identifier for each content item (preferred)

• app_mode - The type of the content item (examples: shiny, rmd-static, static, python-dash, etc.)

• content_category - For static app modes, the specific category of content (examples: site, plot, pin, etc.)

• name - The name of the content item as set at initial publishing

• title - The user-provided title of the content item

• description - The user-provided description of the content item

• url - The URL to the content item

• owner_guid - Unique identifier of the owner of the content item

• owner_username - Username of the owner of the content item

• owner_first_name - First name of the owner of the content item

• owner_last_name - Last name of the owner of the content item

• tags - A data frame of the tags associated with the content item, with format: (id, name, parent_id, created_time, updated_time)

• created_time - The timestamp at which the content item was created

• updated_time - The timestamp at which the content item was last updated

Description

bg fg primary secondary success info warning danger base_font code_font heading_font font_scale

Usage

default_theme()

Details

Visit https://rstudio.github.io/bslib/articles/bs4-variables.html to see the full list of theming variables available

Description

Evaluates required columns for widget's input

Usage

evaluate_widget_input(widget, colnames, required)

Arguments

Description

Generate the theme's bslib::bs_dependency to be used by a widget.

Usage

gen_theme_dependency(widget_name, theme, default_base = FALSE)

Arguments

Description

Get docmeta theme name (output: html_document: theme)

Usage

get_bootswatch_theme_name()

Description

Get the current bootswatch theme if any

Usage

get_current_bootswatch_theme()

Description

Get the current user provided bslib theme if any

Usage

get_user_provided_theme()

Description

Resolve and get theme to be used by a widget. It could be the default connectwidgets styling theme or one provided by the user.

Usage

resolve_theme_dependency(widget_name)

Arguments

Description

Renders a card view for the provided content

Usage

rsc_card(content)

Arguments

Description

Output and render functions for using rsc_card within Shiny applications and interactive Rmd documents.

Usage

rsccardOutput(outputId, width = "100%", height = "400px")

renderRsccard(expr, env = parent.frame(), quoted = FALSE)

Arguments

Description

This helper function makes it easy to put HTML elements side by side. It can be called directly from the console but is especially designed to work in an R Markdown document. Note that this is ripped directly from https://github.com/rstudio/crosstalk without the additional bootstrap dependency (since it is already expected in connectwidgets)

Usage

rsc_cols(..., widths = NA, device = c("xs", "sm", "md", "lg"))

Arguments

Value

A browsable HTML element.

Examples

library(htmltools)

# If width is unspecified, equal widths will be used
rsc_cols(
  div(style = css(width="100%", height="400px", background_color="red")),
  div(style = css(width="100%", height="400px", background_color="blue"))
)

# Use NA to absorb remaining width
rsc_cols(widths = c(2, NA, NA),
  div(style = css(width="100%", height="400px", background_color="red")),
  div(style = css(width="100%", height="400px", background_color="blue")),
  div(style = css(width="100%", height="400px", background_color="green"))
)

# Recycling widths
rsc_cols(widths = c(2, 4),
  div(style = css(width="100%", height="400px", background_color="red")),
  div(style = css(width="100%", height="400px", background_color="blue")),
  div(style = css(width="100%", height="400px", background_color="red")),
  div(style = css(width="100%", height="400px", background_color="blue"))
)

Description

Filter content rows with owner, content type and tags, expects the exact same frame passed to the view widget being filtered.

Usage

rsc_filter(content)

Arguments

Description

Output and render functions for using rsc_filter within Shiny applications and interactive Rmd documents.

Usage

rscfilterOutput(outputId, width = "100%", height = "400px")

renderRscfilter(expr, env = parent.frame(), quoted = FALSE)

Arguments

Description

Renders a grid view of the provided content items

Usage

rsc_grid(content)

Arguments

Description

Output and render functions for using rsc_grid within Shiny applications and interactive Rmd documents.

Usage

rscgridOutput(outputId, width = "100%", height = "400px")

renderRscgrid(expr, env = parent.frame(), quoted = FALSE)

Arguments

Description

Search for matching content name/title within the shared data object passed. Expects the exact same frame passed to the view widget being filtered.

Usage

rsc_search(content)

Arguments

Description

Output and render functions for using rsc_search within Shiny applications and interactive Rmd documents.

Usage

rscsearchOutput(outputId, width = "100%", height = "400px")

renderRscsearch(expr, env = parent.frame(), quoted = FALSE)

Arguments

Description

Renders a reactable table of the provided content items

Usage

rsc_table(content)

Arguments

Description

Resolve reactable theme for rsc_table

Usage

rsc_table_sync_theme()

Description

Show warnings for large content

Usage

warning_large_content(content, max_rows = 500)

Arguments

Description

Show warnings of expected columns for widget's input

Usage

warning_widget_input(widget, colnames, expected)

Arguments