Skip to content

Commit

Permalink
Fix deployApp doc string
Browse files Browse the repository at this point in the history
  • Loading branch information
kippandrew committed Jul 7, 2014
1 parent 800ed99 commit 5326c41
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 37 deletions.
2 changes: 1 addition & 1 deletion R/deployApp.R
Expand Up @@ -50,7 +50,7 @@
#' deployApp(launch.browser = FALSE)
#' }
#' @seealso \code{\link{applications}}, \code{\link{terminateApp}}, and
#' \code{\link{restartApp}
#' \code{\link{restartApp}}
#' @export
deployApp <- function(appDir = getwd(),
appName = NULL,
Expand Down
66 changes: 30 additions & 36 deletions man/deployApp.Rd
@@ -1,56 +1,50 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
\name{deployApp}
\alias{deployApp}
\title{Deploy an Application}
\usage{
deployApp(appDir = getwd(), appName = NULL,
account = NULL, upload = TRUE,
launch.browser = getOption("shinyapps.launch.browser", interactive()),
quiet = FALSE)
deployApp(appDir = getwd(), appName = NULL, account = NULL,
upload = TRUE, launch.browser = getOption("shinyapps.launch.browser",
interactive()), quiet = FALSE)
}
\arguments{
\item{appDir}{Directory containing application. Defaults
to current working directory.}
\item{appDir}{Directory containing application. Defaults to
current working directory.}

\item{appName}{Name of application (names must be unique
with ShinyApps accounts). Defaults to the base name of
the specified \code{appDir}.}
\item{appName}{Name of application (names must be unique with ShinyApps
accounts). Defaults to the base name of the specified \code{appDir}.}

\item{account}{ShinyApps 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 \link{accounts}).}
\item{account}{ShinyApps 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 \link{accounts}).}

\item{upload}{If \code{TRUE} (the default) then the
application is uploaded from the local system prior to
deployment. If \code{FALSE} then it is re-deployed using
the last version that was uploaded.}
\item{upload}{If \code{TRUE} (the default) then the application is uploaded
from the local system prior to deployment. If \code{FALSE} then it is
re-deployed using the last version that was uploaded.}

\item{launch.browser}{If true, the system's default web
browser will be launched automatically after the app is
started. Defaults to \code{TRUE} in interactive sessions
only.}
\item{launch.browser}{If true, the system's default web browser will be
launched automatically after the app is started. Defaults to \code{TRUE} in
interactive sessions only.}
\item{quiet}{Request that no status information be
printed to the console during the deployment.}
\item{quiet}{Request that no status information be printed to the console
during the deployment.}
}
\description{
Deploy a \link[shiny:shiny-package]{shiny} application to
the ShinyApps service.
Deploy a \link[shiny:shiny-package]{shiny} application to the ShinyApps
service.
}
\details{
Prior to deploying an application you should call the
\code{\link{setAccountInfo}} function to register your
ShinyApps account on the local system.
Prior to deploying an application you should call the
\code{\link{setAccountInfo}} function to register your ShinyApps account on
the local system.
After the initial deployment of an application from a
given \code{appDir}, subsequent deployments will
automatically use the \code{appName} and \code{account}
parameters of the initial deployment (unless overriden
After the initial deployment of an application from a given \code{appDir},
subsequent deployments will automatically use the \code{appName} and
\code{account} parameters of the initial deployment (unless overriden
explicitly).
For details on options that affect the behavior of
\code{deployApp} see the article on
\link[shinyapps:shinyappsOptions]{package options}.
For details on options that affect the behavior of \code{deployApp} see the
article on \link[shinyapps:shinyappsOptions]{package options}.
}
\examples{
\dontrun{
Expand All @@ -76,6 +70,6 @@ deployApp(launch.browser = FALSE)
}
\seealso{
\code{\link{applications}}, \code{\link{terminateApp}}, and
\code{\link{restartApp}
\code{\link{restartApp}}
}

0 comments on commit 5326c41

Please sign in to comment.