Skip to content

Commit

Permalink
documentation tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
jjallaire committed Oct 3, 2013
1 parent 9f82fab commit b80f006
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 7 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Package: shinyapps
Type: Package
Title: Publish Applications to ShinyApps
Title: Interface to ShinyApps
Version: 0.2
Date: 2013-10-03
Author: JJ Allaire
Maintainer: JJ Allaire <[email protected]>
Description: Interface for publishing shiny applications to the ShinyApps
Description: Interface for deploying shiny applications to the ShinyApps
service
Imports:
digest,
Expand Down
8 changes: 7 additions & 1 deletion R/accounts.R
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@
#' @param name Name of ShinyApps account to save or remove
#' @param token User token for the account
#' @param secret User secret for the account
#' @return
#' \code{accounts} returns a character vector with the names of all accounts
#' registered on the system. \code{accountInfo} returns a list with account
#' details.
#' @rdname accounts
#' @examples
#' \dontrun{
Expand Down Expand Up @@ -97,7 +101,9 @@ removeAccount <- function(name) {
if (!file.exists(configFile))
stop(missingAccountErrorMessage(name))

invisible(file.remove(configFile))
file.remove(configFile)

invisible(NULL)
}


Expand Down
2 changes: 1 addition & 1 deletion R/deployApp.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

#' Deploy Applications to ShinyApps
#' Deploy an Application
#'
#' Deploy a \link[shiny:shiny-package]{shiny} application to the ShinyApps
#' service.
Expand Down
5 changes: 5 additions & 0 deletions man/accounts.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@

\item{secret}{User secret for the account}
}
\value{
\code{accounts} returns a character vector with the names
of all accounts registered on the system.
\code{accountInfo} returns a list with account details.
}
\description{
Functions to add, enumerate, and remove ShinyApps
accounts on the local system. Prior to deploying
Expand Down
2 changes: 1 addition & 1 deletion man/deployApp.Rd
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
\name{deployApp}
\alias{deployApp}
\title{Deploy Applications to ShinyApps}
\title{Deploy an Application}
\usage{
deployApp(appDir = getwd(), appName = NULL,
account = NULL,
Expand Down
4 changes: 2 additions & 2 deletions man/shinyapps-package.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
\alias{shinyapps}
\docType{package}
\title{
Publish Applications to ShinyApps
Interface to ShinyApps
}
\description{
Interface for publishing \pkg{shiny} applications to the ShinyApps service.
Interface for deploying \pkg{shiny} applications to the ShinyApps service.
}
\details{
\tabular{ll}{
Expand Down

0 comments on commit b80f006

Please sign in to comment.