To use a RStudio Connect board, you need to first authenticate. The easiest way to do so is by launching Tools - Global Options - Publishing - Connect, and follow the instructions.
You can share pins with others in RStudio Connect by changing the viewers of the document to specific users or groups. This is accomplished by opening the new published pin and then changing access under the settings tab. After you've shared the pin, it will be automatically available to others.
Usage
board_rsconnect(
auth = c("auto", "manual", "envvar", "rsconnect"),
server = NULL,
account = NULL,
key = NULL,
output_files = FALSE,
cache = NULL,
name = "rsconnect",
versioned = TRUE,
use_cache_on_failure = is_interactive(),
versions = deprecated()
)
Arguments
- auth
There are three ways to authenticate:
auth = "manual"
uses argumentsserver
andkey
.auth = "envvar"
uses environment variablesCONNECT_API_KEY
andCONNECT_SERVER
.auth = "rsconnect"
uses servers registered with the rsconnect package (filtered byserver
andaccount
, if provided)
The default,
auth = "auto"
, automatically picks between the three options, using"manual"
ifserver
andkey
are provided,"envvar"
if both environment variables are set, and"rsconnect"
otherwise.- server
For
auth = "manual"
orauth = 'envvar'
, the full url to the server, likehttp://server.rstudio.com/rsc
orhttps://connect.rstudio.com/
. Forauth = 'rsconnect'
a host name used to disambiguate RSC accounts, likeserver.rstudio.com
orconnect.rstudio.com
.- account
A user name used to disambiguate multiple RSC accounts.
- key
The RStudio Connect API key.
- output_files
- cache
Cache path. Every board requires a local cache to avoid downloading files multiple times. The default stores in a standard cache location for your operating system, but you can override if needed.
- name
An optional name used identify the board. This is no longer generally needed since you should be passing around an explicit board object.
- versioned
Should this board be registered with support for versions?
- use_cache_on_failure
If the pin fails to download, is it ok to use the last cached version? Defaults to
is_interactive()
so you'll be robust to poor internet connectivity when exploring interactively, but you'll get clear errors when the code is deployed.- versions
Should this board be registered with support for versions?
Public pins
If your RSC instance allows it, you can share a pin publicly by setting the
access type to all
:
(You can also do this in RSC by setting "Access" to "Anyone - no login required")
Now anyone can read your pin through board_url()
:
board <- board_url(c(
my_df = "https://connect.rstudioservices.com/content/3004/"
))
board %>% pin_read("my_df")
You can find the URL of a pin with pin_browse()
.
See also
Other boards:
board_folder()
,
board_url()