Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rstudio/connectwidgets
The {connectwidgets} package allows you to curate your content on RStudio Connect, helping to create organized groups of content within an RMarkdown document or Shiny app.
https://github.com/rstudio/connectwidgets
Last synced: 3 months ago
JSON representation
The {connectwidgets} package allows you to curate your content on RStudio Connect, helping to create organized groups of content within an RMarkdown document or Shiny app.
- Host: GitHub
- URL: https://github.com/rstudio/connectwidgets
- Owner: rstudio
- License: other
- Created: 2021-01-07T03:25:25.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-20T21:19:44.000Z (about 1 year ago)
- Last Synced: 2024-07-13T23:02:18.975Z (4 months ago)
- Language: R
- Homepage: https://rstudio.github.io/connectwidgets/
- Size: 3.4 MB
- Stars: 21
- Watchers: 50
- Forks: 7
- Open Issues: 28
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
Awesome Lists containing this project
- awesome-shiny-extensions - connectwidgets - Query a Posit Connect server for a subset of content items, then organize them within htmlwidget components in R Markdown documents or Shiny applications. (Deploy / Remote Deploy)
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# connectwidgets 
Curate your content on Posit Connect
[](https://CRAN.R-project.org/package=connectwidgets)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
[](https://github.com/rstudio/connectwidgets/actions/workflows/R-CMD-check.yaml)
[](https://github.com/rstudio/connectwidgets/actions/workflows/lint.yaml)
`connectwidgets` is an R package that can be used to query a Posit Connect server for a subset of your existing content items, then organize them within `htmlwidget` components in an R Markdown document or Shiny application.
Use `connectwidgets` to create a content hub or knowledge repository, a customized summary page for a particular group of stakeholders, or a presentation layer for any group of related content.
## Installation
You can install `connectwidgets` from CRAN using:
```r
install.packages("connectwidgets")
```
Alternatively, you can install the development version from GitHub:
```r
# install.packages("remotes")
remotes::install_github("rstudio/connectwidgets")
```
## Example
Use the template:
```{r, eval=FALSE}
rmarkdown::draft("example-page.Rmd", template = "connectwidgets", package = "connectwidgets")
```
You can also copy and knit the following example, or read on for more details:
````markdown
---
title: an example page
output: html_document
---
```{r setup, include=FALSE}`r ''`
library(connectwidgets)
library(dplyr)
knitr::opts_chunk$set(echo = FALSE, message = FALSE, warning = FALSE)
client <- connect(
# server = Sys.getenv("CONNECT_SERVER"),
# api_key = Sys.getenv("CONNECT_API_KEY")
)
all_content <- client %>%
content()
sample_content <- all_content %>%
arrange(desc(updated_time)) %>%
slice_head(n = 50)
```
## Components
### card
```{r card}`r ''`
sample_content %>%
slice(1) %>%
rsc_card()
```
### grid
```{r grid}`r ''`
sample_content %>%
rsc_grid()
```
### table
```{r table}`r ''`
sample_content %>%
rsc_table()
```
### search & filter
```{r search-and-filter}`r ''`
rsc_cols(rsc_search(all_content), rsc_filter(all_content), widths = c(2, 2))
rsc_table(all_content)
```
````
### Setup
The client object:
- Validates your API key with the Posit Connect server
- Ensures you are running a recent enough version of Connect
Use an `.Renviron` file to set the `CONNECT_SERVER` and `CONNECT_API_KEY`
environment variables.
If you're not familiar with setting environment variables, check out the
[R Startup chapter](https://rstats.wtf/r-startup.html#renviron)
of What They Forgot to Teach You About R.
Posit Connect will [automatically apply](https://docs.posit.co/connect/user/content-settings/#content-vars)
values for these at document run time,
so there is no need to include them in your code:
```{r warning = FALSE, message = FALSE}
library(connectwidgets)
library(dplyr, warn.conflicts = FALSE)
knitr::opts_chunk$set(echo = FALSE, message = FALSE, warning = FALSE)
client <- connect(
# server = Sys.getenv("CONNECT_SERVER"),
# api_key = Sys.getenv("CONNECT_API_KEY")
)
all_content <- client %>%
content()
glimpse(all_content)
sample_content <- all_content %>%
arrange(desc(updated_time)) %>%
slice_head(n = 100)
```
#### `content()`
`content()` returns a data frame with the following columns:
* `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 the following columns: `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
The data frame contains one row for each item visible to the requesting user.
For users in an "administrator" role, that will be all content items.
#### Filtering Content
We provide helper functions to filter by both owners and tags.
- `by_tags()` - Filters the data frame to only include content that has been
tagged with the specified tag name(s). You can pass a single tag name or a vector
of tag names. `by_tag` is provided as an alias for readability when using a
single tag.
- `by_owners()` - Filters the data frame to only include content with the
specified owner(s) by username. You can pass a single username or a vector of
usernames. `by_owner` is provided as an alias for readability when using a
single username.
```{r, echo=TRUE}
all_content %>%
by_tag("Audit Reports")
```
Since `all_content` is a `tibble()`, you can also manipulate it with dplyr:
```{r, echo=TRUE}
all_content %>%
filter(updated_time >= "2021-01-01") %>%
arrange(created_time)
```
### Components
Once your content data are filtered, `connectwidgets` provides components for
displaying information about them. The title, description, and preview image can be set
[from the Posit Connect dashboard.](https://docs.posit.co/connect/user/content-settings/#content-metadata)
For content deployed to Connect where no image has been supplied, a default image will be used.
*Note:* In many cases, you will only see default images until your content is deployed.
#### card
Use a card to highlight an individual piece of content:
#### grid
Display multiple content items via a grid:
#### table
Provide a more detailed view with a table:
#### search & filter
The search and filter components help viewers find the content they are most interested in.
You must pass the same content data frame to `rsc_search()`, `rsc_filter()`,
and `rsc_table()` or `rsc_grid()` in order for filter and search to work.
You can also create your own `crosstalk::SharedData()` object to pass to
the components if you want more control over searching and filtering.
Read more at `vignette("using-crosstalk")`.
## Theming
`connectwidgets` components support styling in `rmarkdown::html_document` via the [`bslib`](https://rstudio.github.io/bslib/) package.
You can supply a [Bootswatch theme](https://bootswatch.com/4/) in the yaml header, e.g.:
```yaml
---
output:
html_document:
theme:
bootswatch: minty
---
```
or pass a custom theme consistent with your organization's style:
```yaml:
---
output:
html_document:
theme:
bg: "#FFF"
fg: "#22333B"
primary: "#4F772D"
dark: "#252525"
light: "#DCE6D3"
base_font: "Lato, sans-serif"
heading_font: "Lato, sans-serif"
border-color: "#E9F5DB"
gray-100: "#F7FCF0"
---
```
Once you're happy with the look of your page, Publish it to Posit Connect.
Read more at `vignette("publishing")`.
## A more customized example:
Putting it all together, the example API portal page below:
- uses CSS to create a full-width image with inset text
- uses a Bootswatch theme
- overrides the `description` text for a couple of cards
If no APIs are deployed on your Posit Connect server,
try filtering for static documents or Shiny apps instead.
````markdown
---
output:
html_document:
theme:
bootswatch: lumen
---
```{css, echo=FALSE}`r ''`
.main-container {
width: 100%;
max-width: unset;
}
.main {
max-width: 940px;
margin-left: auto;
margin-right: auto;
}
/* https://codepen.io/eversionsystems/pen/YOmqdj */
.jumbotron {
color: white;
background-image: url("https://source.unsplash.com/d30sszrW7Vw/1920x1080");
background-position: center;
background-repeat: no-repeat;
background-size: cover;
height: 50vh;
}
```
```{r, include=FALSE}`r ''`
library(connectwidgets)
library(dplyr)
library(htmltools)
knitr::opts_chunk$set(
comment = "",
echo = FALSE, warning = FALSE, message = FALSE
)
rsc_content <-
connect() %>%
content()
apis <- rsc_content %>%
filter(app_mode %in% c("api", "python-api"))
```
```{r}`r ''`
div(
class = "jumbotron jumbotron-fluid",
div(
class = "container",
h1("Connect API Portal", class = "display-4"),
p("Model APIs maintained by the data science team")
)
)
```
```{r}`r ''`
div(
class = "main",
h3("Featured APIs", class = "text-center"),
{
model_copy <- c(
"Our most important model: Distillery retro taiyaki fashion axe.
Art party cray intelligentsia flexitarian.",
"Our second most important model: Pug af twee portland pitchfork brunch
kogi gochujang organic migas shaman four dollar toast 90's slow-carb."
)
apis %>%
slice_head(n = 2) %>%
mutate(
description = model_copy
) %>%
rsc_card()
},
h3("All APIs", class = "text-center"),
p("that thing George Box said one time. You know what thing."),
{
tagList(
rsc_cols(rsc_search(apis), rsc_filter(apis)),
rsc_grid(apis)
)
}
)
```
````