rsconnect (version 0.7)

deployApp: Deploy an Application

Description

Deploy a shiny application, an R Markdown document, or HTML content to a server.

Usage

deployApp(appDir = getwd(), appFiles = NULL, appFileManifest = NULL, appPrimaryDoc = NULL, appSourceDoc = NULL, appName = NULL, appTitle = NULL, contentCategory = NULL, account = NULL, server = NULL, upload = TRUE, launch.browser = getOption("rsconnect.launch.browser", interactive()), logLevel = c("normal", "quiet", "verbose"), lint = TRUE, metadata = list())

Arguments

appDir

Directory containing application. Defaults to current working directory.

appFiles

The files and directories to bundle and deploy (only if upload = TRUE). Can be NULL, in which case all the files in the directory containing the application are bundled. Takes precedence over appFileManifest if both are supplied.

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 appDir.

appPrimaryDoc

If the application contains more than one document, this parameter indicates the primary one, as a path relative to appDir. Can be NULL, in which case the primary document is inferred from the contents being deployed.

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 deployments is associated with the source document.

appName

Name of application (names must be unique within an account). Defaults to the base name of the specified appDir.

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 appTitle to receive an auto-generated appName.

contentCategory

Optional; the kind of content being deployed (e.g. "plot", "document", or "application").

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 TRUE (the default) then the application is uploaded from the local system prior to deployment. If FALSE then it is re-deployed using the last version that was uploaded.

launch.browser

If true, the system's default web browser will be launched automatically after the app is started. Defaults to TRUE in interactive sessions only.

logLevel

One of "quiet", "normal" or "verbose"; indicates how much logging to the console is to be performed. At "quiet" reports no information; at "verbose", a full diagnostic log is captured.

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 deployments.

See Also

applications, terminateApp, and restartApp

Examples

## 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)
# ## End(Not run)