Learn R Programming

⚠️There's a newer version (1.7.0) of this package.Take me there.

rsconnect

rsconnect makes it easy to publish your Shiny apps, RMarkdown and Quarto documents, and Plumber APIs to Posit Connect, ShinyApps.io, and Posit Cloud from R.

(If you’re looking for the Python equivalent, try rsconnect-python.)

Installation

You can install the released version of rsconnect from CRAN with:

install.packages("rsconnect")

And the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("rstudio/rsconnect")

Setup

To use rsconnect, you first need to teach it about the server you want to publish to. If you use the RStudio IDE, the easiest way to get set up is to use the publishing dialog, which you can find by clicking the “Tools” menu, then selecting “Global options”, then clicking “Publishing”. Click “Connect” to add new servers.

You can also connect from any R session by running a little code:

  • For shinyapps.io, go to your tokens page and click “Add Token”, then follow the instructions to copy and paste the appropriate call to setAccountInfo(). Learn more in the Getting Started Guide.

  • For Posit Connect, first use addServer() to register your server with rsconnect, then call either connectUser() or connectApiUser(). connectUser() is a bit simpler if you’re in an interactive session; connectApiUser() works anywhere but requires a you to copy and paste an API key from your user profile.

  • For Posit Cloud, login, then click your name in the top-right corner, click “Account”, then click “Tokens” in the navbar at the top of the page. Click “New Token”, then “Copy” next to the token you just created, and then follow the instructions to copy and paste the appropriate call to setAccountInfo().

Now that you’re setup you can use deployApp(), deployDoc(), and friends to publish your apps, documentations, APIs and more.

Copy Link

Version

Install

install.packages('rsconnect')

Monthly Downloads

51,594

Version

1.2.2

License

GPL-2

Issues

Pull Requests

Stars

Forks

Maintainer

Aron Atkins

Last Published

April 4th, 2024

Functions in rsconnect (1.2.2)

rsconnectOptions

Package Options
purgeApp

Purge an Application
linter

Create a Linter
configureApp

Configure an Application
discoverServers

Discover servers automatically
resendInvitation

Resend invitation for invited users of an application
connectApiUser

Register account on Posit Connect
listDeploymentFiles

Gather files to be bundled with an app
rpubsUpload

Upload a file to RPubs
forgetDeployment

Forget Application Deployment
restartApp

Restart an Application
removeAuthorizedUser

Remove authorized user from an application
listBundleFiles

List Files to be Bundled
makeLinterMessage

Construct a Linter Message
taskLog

Show task log
tasks

List Tasks
listAccountEnvVars

Maintain environment variables across multiple applications
showLogs

Show Application Logs
rsconnectPackages

Using Packages with rsconnect
showMetrics

Show Application Metrics
unsetProperty

Unset Application property
showProperties

Show Application property
terminateApp

Terminate an Application
writeManifest

Create a manifest.json
showUsage

Show Application Usage
rsconnectProxies

HTTP Proxy Configuration
oldApplicationConfigDir

Old Application Config Directory
setProperty

Set Application property
lint

Lint a Project
showInvited

List invited users for an application
generateAppName

Generate Application Name
setAccountInfo

Register account on shinyapps.io or posit.cloud
rsconnectConfigDir

rsconnect Configuration Directory
servers

Server metadata
rsconnect-package

rsconnect: Deploy Docs, Apps, and APIs to 'Posit Connect', 'shinyapps.io', and 'RPubs'
showUsers

List authorized users for an application
syncAppMetadata

Update deployment records
appDependencies

Detect application dependencies
addAuthorizedUser

Add authorized user to application
addServer

Server management
addLinter

Add a Linter
accounts

Account Management Functions
accountUsage

Show Account Usage
applications

List Deployed Applications
authorizedUsers

(Deprecated) List authorized users for an application
addConnectServer

Add a server
deployments

List Application Deployments
deployTFModel

Deploy a TensorFlow saved model
deployDoc

Deploy a single document
deploySite

Deploy a website
applicationConfigDir

Application Configuration Directory
deployAPI

Deploy a Plumber API
deployApp

Deploy an Application