View source: R/board_connect.R
board_connect | R Documentation |
To use a Posit Connect board, you need to first authenticate. The easiest way to do so is using the RStudio IDE and choosing Tools - Global Options - Publishing - Connect, then following the instructions.
You can share pins with others in Posit 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.
board_connect(
auth = c("auto", "manual", "envvar", "rsconnect"),
server = NULL,
account = NULL,
key = NULL,
cache = NULL,
name = "posit-connect",
versioned = TRUE,
use_cache_on_failure = is_interactive()
)
board_rsconnect(
auth = c("auto", "manual", "envvar", "rsconnect"),
server = NULL,
account = NULL,
key = NULL,
output_files = FALSE,
cache = NULL,
name = "posit-connect",
versioned = TRUE,
use_cache_on_failure = is_interactive()
)
auth |
There are three ways to authenticate:
The default, |
server |
For |
account |
A user name used to disambiguate multiple Connect accounts. |
key |
The Posit Connect API key. |
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 |
output_files |
If your Posit Connect instance allows it, you can share a pin publicly by
setting the access type to all
:
board %>% pin_write(my_df, access_type = "all")
(You can also do this in Posit Connect by setting "Access" to "Anyone - no login required")
Now anyone can read your pin through board_url()
:
board <- board_url(c( numbers = "https://pub.current.posit.team/public/great-numbers/" )) board %>% pin_read("numbers")
You can find the URL of a pin with pin_browse()
.
Other boards:
board_connect_url()
,
board_folder()
,
board_url()
## Not run:
board <- board_connect()
# Share the mtcars with your team
board %>% pin_write(mtcars, "mtcars")
# Download a shared dataset
board %>% pin_read("timothy/mtcars")
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.