deployApp {rsconnect} | R Documentation |
Deploy a shiny application, an RMarkdown document, a plumber API, or HTML content to a server.
deployApp(
appDir = getwd(),
appFiles = NULL,
appFileManifest = NULL,
appPrimaryDoc = NULL,
appSourceDoc = NULL,
appName = NULL,
appTitle = NULL,
appId = NULL,
contentCategory = NULL,
account = NULL,
server = NULL,
upload = TRUE,
recordDir = NULL,
launch.browser = getOption("rsconnect.launch.browser", interactive()),
on.failure = NULL,
logLevel = c("normal", "quiet", "verbose"),
lint = TRUE,
metadata = list(),
forceUpdate = getOption("rsconnect.force.update.apps", FALSE),
python = NULL,
forceGeneratePythonEnvironment = FALSE,
quarto = NULL,
appVisibility = NULL,
image = NULL
)
appDir |
Directory containing application. Defaults to current working directory. |
appFiles |
The files and directories to bundle and deploy (only if
|
appFileManifest |
An alternate way to specify the files to be deployed;
a file containing the names of the files, one per line, relative to the
|
appPrimaryDoc |
If the application contains more than one document, this
parameter indicates the primary one, as a path relative to |
appSourceDoc |
If the application is composed of static files (e.g
HTML), this parameter indicates the source document, if any, as a fully
qualified path. Deployment information returned by |
appName |
Name of application (names must be unique within an account).
Defaults to the base name of the specified |
appTitle |
Free-form descriptive title of application. Optional; if
supplied, will often be displayed in favor of the name. When deploying a
new application, you may supply only the |
appId |
If updating an application, the ID of the application being updated. Optional unless updating an app owned by another user. |
contentCategory |
Optional; the kind of content being deployed (e.g.
|
account |
Account to deploy application to. This parameter is only required for the initial deployment of an application when there are multiple accounts configured on the system (see accounts). |
server |
Server name. Required only if you use the same account name on multiple servers. |
upload |
If |
recordDir |
Directory where publish record is written. Can be |
launch.browser |
If true, the system's default web browser will be
launched automatically after the app is started. Defaults to |
on.failure |
Function to be called if the deployment fails. If a deployment log URL is available, it's passed as a parameter. |
logLevel |
One of |
lint |
Lint the project before initiating deployment, to identify potentially problematic code? |
metadata |
Additional metadata fields to save with the deployment
record. These fields will be returned on subsequent calls to
|
forceUpdate |
If |
python |
Full path to a python binary for use by |
forceGeneratePythonEnvironment |
Optional. If an existing
|
quarto |
Optional. Full path to a Quarto binary for use deploying Quarto
content. The provided Quarto binary will be used to run |
appVisibility |
One of |
image |
Optional. The name of the image to use when building and executing this content. If none is provided, RStudio Connect will attempt to choose an image based on the content requirements. |
applications()
, terminateApp()
, and restartApp()
Other Deployment functions:
applications()
,
deployAPI()
,
deployDoc()
,
deploySite()
,
deployTFModel()
## Not run:
# deploy the application in the current working dir
deployApp()
# deploy an application in another directory
deployApp("~/projects/shiny/app1")
# deploy using an alternative application name and title
deployApp("~/projects/shiny/app1", appName = "myapp",
appTitle = "My Application")
# deploy specifying an explicit account name, then
# redeploy with no arguments (will automatically use
# the previously specified account)
deployApp(account = "jsmith")
deployApp()
# deploy but don't launch a browser when completed
deployApp(launch.browser = FALSE)
# deploy a Quarto website, using the quarto package to
# find the Quarto binary
deployApp("~/projects/quarto/site1", quarto = quarto::quarto_path())
## End(Not run)