rsconnect/ 0000755 0001762 0000144 00000000000 13574766702 012271 5 ustar ligges users rsconnect/NAMESPACE 0000644 0001762 0000144 00000002432 13574762023 013501 0 ustar ligges users # Generated by roxygen2: do not edit by hand
export(accountInfo)
export(accountUsage)
export(accounts)
export(addAuthorizedUser)
export(addConnectServer)
export(addLinter)
export(addServer)
export(addServerCertificate)
export(appDependencies)
export(applications)
export(authorizedUsers)
export(configureApp)
export(connectApiUser)
export(connectUser)
export(deployAPI)
export(deployApp)
export(deployDoc)
export(deploySite)
export(deployTFModel)
export(deployments)
export(discoverServers)
export(forgetDeployment)
export(generateAppName)
export(lint)
export(linter)
export(listBundleFiles)
export(purgeApp)
export(removeAccount)
export(removeAuthorizedUser)
export(removeServer)
export(restartApp)
export(rpubsUpload)
export(serverInfo)
export(servers)
export(setAccountInfo)
export(setProperty)
export(showInvited)
export(showLogs)
export(showMetrics)
export(showProperties)
export(showUsage)
export(showUsers)
export(taskLog)
export(tasks)
export(terminateApp)
export(unsetProperty)
export(writeManifest)
importFrom(stats,na.omit)
importFrom(stats,setNames)
importFrom(utils,available.packages)
importFrom(utils,contrib.url)
importFrom(utils,file_test)
importFrom(utils,formatUL)
importFrom(utils,getFromNamespace)
importFrom(utils,glob2rx)
importFrom(utils,packageVersion)
importFrom(utils,read.csv)
rsconnect/README.md 0000644 0001762 0000144 00000002720 13561066365 013543 0 ustar ligges users
# rsconnect
[](https://cran.r-project.org/package=rsconnect)
[](https://travis-ci.org/rstudio/rsconnect)
[](https://www.tidyverse.org/lifecycle/#stable)
An R package used for deploying applications to the
[ShinyApps](http://shinyapps.io/) hosted service, or to [RStudio
Connect](https://www.rstudio.com/products/connect/).
## Installation
You can install the released version of rsconnect from
[CRAN](https://CRAN.R-project.org) with:
``` r
install.packages("rsconnect")
```
And the development version from [GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("rstudio/rsconnect")
```
## Example
To get started using ShinyApps check out the [Getting Started
Guide](http://shiny.rstudio.com/articles/shinyapps.html).
For more information using RStudio Connect, see the [RStudio Connect
User Guide](http://docs.rstudio.com/connect/user/index.html).
## Legal Stuff
TensorFlow, the TensorFlow logo and any related marks are trademarks of
Google Inc., and are not affiliated with RStudio, Inc.
rsconnect/man/ 0000755 0001762 0000144 00000000000 13572046105 013026 5 ustar ligges users rsconnect/man/rsconnect-package.Rd 0000644 0001762 0000144 00000003233 13561066365 016715 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rsconnect-package.R
\docType{package}
\name{rsconnect-package}
\alias{rsconnect-package}
\alias{rsconnect}
\title{Deployment Interface for R Markdown Documents and Shiny Applications}
\description{
The `rsconnect`` package provides a programmatic deployment
interface for RPubs, shinyapps.io, and RStudio Connect. Supported contents
types include R Markdown documents, Shiny applications, plots, and static
web content.
}
\section{Managing Applications}{
Deploy and manage applications with the following functions:
\itemize{
\item \code{\link[=deployApp]{deployApp()}}:
Deploy a Shiny application to a server.
\item \code{\link[=configureApp]{configureApp()}}:
Configure an application currently running on a server.
\item \code{\link[=restartApp]{restartApp()}}:
Restart an application currently running on a server.
\item \code{\link[=terminateApp]{terminateApp()}}:
Terminate an application currently running on a server.
\item \code{\link[=deployments]{deployments()}}:
List deployment records for a given application directory.
}
More information on application management is available in the
\code{\link[=applications]{applications()}} help page.
}
\section{Managing Accounts and Users}{
Manage accounts on the local system.
\itemize{
\item \code{\link[=setAccountInfo]{setAccountInfo()}}:
Register an account.
\item \code{\link[=removeAccount]{removeAccount()}}:
Remove an account.
\item \code{\link[=accountInfo]{accountInfo()}}:
View information for a given account.
}
More information on account management is available in the
\code{\link[=accounts]{accounts()}} help page.
}
\keyword{package}
rsconnect/man/connectUser.Rd 0000644 0001762 0000144 00000002201 13572046105 015600 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/accounts.R
\name{connectUser}
\alias{connectUser}
\title{Connect User Account}
\usage{
connectUser(account = NULL, server = NULL, quiet = FALSE)
}
\arguments{
\item{account}{A name for the account to connect. Optional.}
\item{server}{The server to connect to. Optional if there is only one server
registered.}
\item{quiet}{Whether or not to show messages and prompts while connecting the
account.}
}
\description{
Connect a user account to the package so that it can be used to deploy and
manage applications on behalf of the account.
}
\details{
When this function is invoked, a web browser will be opened to a
page on the target server where you will be prompted to enter your
credentials. Upon successful authentication, your local installation of
\pkg{rsconnect} and your server account will be paired, and you'll
be able to deploy and manage applications using the package without further
prompts for credentials.
}
\seealso{
Other Account functions: \code{\link{accounts}},
\code{\link{connectApiUser}},
\code{\link{setAccountInfo}}
}
\concept{Account functions}
rsconnect/man/rsconnectPackages.Rd 0000644 0001762 0000144 00000004263 13561066365 016767 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/packages.R
\name{rsconnectPackages}
\alias{rsconnectPackages}
\title{Using Packages with rsconnect}
\description{
Deployed applications can depend on any package available on CRAN as well as any package hosted in a public \href{https://www.github.com}{GitHub} repository.
When an application is deployed it's source code is scanned for dependencies using the \code{\link[=appDependencies]{appDependencies()}} function. The list of dependencies is sent to the server along with the application source code and these dependencies are then installed alongside the application.
Note that the \code{Suggests} dependencies of packages are not automatically included in the list of dependent packages. See the \emph{Note} section of the documentation of the \code{\link[=appDependencies]{appDependencies()}} function for details on how to force packages to be included in the dependency list.
}
\section{CRAN Packages}{
When sastisfying CRAN package dependencies, the server will build the exact versions of packages that were installed on the system from which the application is deployed.
If a locally installed package was not obtained from CRAN (e.g. was installed from R-Forge) and as a result doesn't have a version that matches a version previously published to CRAN then an error will occur. It's therefore important that you run against packages installed directly from CRAN in your local configuration.
}
\section{GitHub Packages}{
It's also possible to depend on packages hosted in public GitHub repositories, so long as they are installed via the \code{\link[devtools:install_github]{devtools::install_github()}} function from the \pkg{devtools} package.
This works because \code{install_github} records the exact Github commit that was installed locally, making it possible to download and install the same source code on the deployment server.
Note that in order for this to work correctly you need to install the very latest version of \code{devtools} from Github. You can do this as follows:
\preformatted{
library(devtools)
install_github("r-lib/devtools")
}
}
\seealso{
\code{\link[=appDependencies]{appDependencies()}}
}
rsconnect/man/purgeApp.Rd 0000644 0001762 0000144 00000001705 13561066365 015113 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/purgeApp.R
\name{purgeApp}
\alias{purgeApp}
\title{Purge an Application}
\usage{
purgeApp(appName, account = NULL, server = NULL, quiet = FALSE)
}
\arguments{
\item{appName}{Name of application to purge}
\item{account}{Account name. If a single account is registered on the system
then this parameter can be omitted.}
\item{server}{Server name. Required only if you use the same account name on
multiple servers (see \code{\link[=servers]{servers()}})}
\item{quiet}{Request that no status information be printed to the console
during the termination.}
}
\description{
Purge a currently archived ShinyApps application.
}
\note{
This function only works for ShinyApps servers.
}
\examples{
\dontrun{
# purge an application
purgeApp("myapp")
}
}
\seealso{
\code{\link[=applications]{applications()}}, \code{\link[=deployApp]{deployApp()}}, and
\code{\link[=restartApp]{restartApp()}}
}
rsconnect/man/addAuthorizedUser.Rd 0000644 0001762 0000144 00000002301 13561066365 016747 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/auth.R
\name{addAuthorizedUser}
\alias{addAuthorizedUser}
\title{Add authorized user to application}
\usage{
addAuthorizedUser(email, appDir = getwd(), appName = NULL,
account = NULL, server = NULL, sendEmail = NULL,
emailMessage = NULL)
}
\arguments{
\item{email}{Email address of user to add.}
\item{appDir}{Directory containing application. Defaults to
current working directory.}
\item{appName}{Name of application.}
\item{account}{Account name. If a single account is registered on the
system then this parameter can be omitted.}
\item{server}{Server name. Required only if you use the same account name on
multiple servers.}
\item{sendEmail}{Send an email letting the user know the application
has been shared with them.}
\item{emailMessage}{Optional character vector of length 1 containing a
custom message to send in email invitation. Defaults to NULL, which
will use default invitation message.}
}
\description{
Add authorized user to application
}
\note{
This function works only for ShinyApps servers.
}
\seealso{
\code{\link[=removeAuthorizedUser]{removeAuthorizedUser()}} and \code{\link[=showUsers]{showUsers()}}
}
rsconnect/man/configureApp.Rd 0000644 0001762 0000144 00000002716 13561066365 015755 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/configureApp.R
\name{configureApp}
\alias{configureApp}
\title{Configure an Application}
\usage{
configureApp(appName, appDir = getwd(), account = NULL,
server = NULL, redeploy = TRUE, size = NULL, instances = NULL,
logLevel = c("normal", "quiet", "verbose"))
}
\arguments{
\item{appName}{Name of application to configure}
\item{appDir}{Directory containing application. Defaults to
current working directory.}
\item{account}{Account name. If a single account is registered on the
system then this parameter can be omitted.}
\item{server}{Server name. Required only if you use the same account name on
multiple servers (see \code{\link[=servers]{servers()}})}
\item{redeploy}{Re-deploy application after its been configured.}
\item{size}{Configure application instance size}
\item{instances}{Configure number of application instances}
\item{logLevel}{One of \code{"quiet"}, \code{"normal"} or \code{"verbose"}; indicates how
much logging to the console is to be performed. At \code{"quiet"} reports no
information; at \code{"verbose"}, a full diagnostic log is captured.}
}
\description{
Configure an application running on a remote server.
}
\note{
This function works only for ShinyApps servers.
}
\examples{
\dontrun{
# set instance size for an application
configureApp("myapp", size="xlarge")
}
}
\seealso{
\code{\link[=applications]{applications()}}, \code{\link[=deployApp]{deployApp()}}
}
rsconnect/man/deployTFModel.Rd 0000644 0001762 0000144 00000003341 13561066365 016035 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/deployTFModel.R
\name{deployTFModel}
\alias{deployTFModel}
\title{Deploy a TensorFlow saved model}
\usage{
deployTFModel(modelDir, ...)
}
\arguments{
\item{modelDir}{Path to the saved model directory. MUST contain
\emph{saved_model.pb} or \emph{saved_model.pbtxt}}
\item{...}{Additional arguments to \code{\link[=deployApp]{deployApp()}}.}
}
\description{
Deploys a directory containing a Tensorflow saved model file.
}
\details{
Deploy a single Tensorflow saved model as a bundle. Should be passed a
directory that contains the \emph{saved_model.pb} or \emph{saved_model.pbtxt} file,
as well as any variables and assets necessary to load the model.
A saved model directory might look like this:\preformatted{./1/
./1/saved_model.pb or ./1/saved_model.pbtxt
./1/variables/
./1/variables/variables.data-00000-of-00001
./1/variables/variables.index
}
For information on creating saved models, see the Keras method
\code{\link[keras:export_savedmodel.keras.engine.training.Model]{keras::export_savedmodel.keras.engine.training.Model()}} or the TensorFlow
method \code{\link[tensorflow:export_savedmodel]{tensorflow::export_savedmodel()}}. If using the TensorFlow package for
R, the official \href{https://www.tensorflow.org/programmers_guide/saved_model#overview_of_saving_and_restoring_models}{TensorFlow guide for saving and restoring models}
may be useful.
}
\references{
\url{https://www.tensorflow.org/programmers_guide/saved_model#overview_of_saving_and_restoring_models}
}
\seealso{
Other Deployment functions: \code{\link{applications}},
\code{\link{deployAPI}}, \code{\link{deployApp}},
\code{\link{deployDoc}}, \code{\link{deploySite}}
}
\concept{Deployment functions}
rsconnect/man/generateAppName.Rd 0000644 0001762 0000144 00000002564 13561066365 016370 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/title.R
\name{generateAppName}
\alias{generateAppName}
\title{Generate Application Name}
\usage{
generateAppName(appTitle, appPath = NULL, account = NULL,
unique = TRUE)
}
\arguments{
\item{appTitle}{A descriptive title for the application.}
\item{appPath}{The path to the application's content, either a directory
or an individual document. Optional.}
\item{account}{The account where the application will be deployed. Optional.}
\item{unique}{Whether to try to generate a unique name.}
}
\value{
Returns a valid short name for the application.
}
\description{
Generate a short name (identifier) for an application given an application
title.
}
\details{
This function modifies the title until it forms a suitable application name.
Suitable application names are 3 - 64 characters long and contain only
alphanumeric characters.
The function is intended to be used to find a name for a new application.
If \code{appPath} and \code{account} are both specified, then the returned
name will also be unique among locally known deployments of the directory
(note that it is not guaranteed to be unique on the server). This behavior
can be disabled by setting \code{unique = FALSE}.
}
\examples{
# Generate a short name for a sample application
generateAppName("My Father's Country", "~/fathers-country", "myacct")
}
rsconnect/man/servers.Rd 0000644 0001762 0000144 00000004172 13561066365 015022 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/servers.R
\name{servers}
\alias{servers}
\alias{discoverServers}
\alias{addConnectServer}
\alias{addServer}
\alias{removeServer}
\alias{serverInfo}
\alias{addServerCertificate}
\title{Server Management Functions}
\usage{
servers(local = FALSE)
discoverServers(quiet = FALSE)
addConnectServer(url, name = NULL, certificate = NULL, quiet = FALSE)
addServer(url, name = NULL, certificate = NULL, quiet = FALSE)
removeServer(name)
serverInfo(name)
addServerCertificate(name, certificate, quiet = FALSE)
}
\arguments{
\item{local}{Return only local servers (i.e. not \code{shinyapps.io})}
\item{quiet}{Suppress output and prompts where possible.}
\item{url}{Server's URL. Should look like \code{http://servername/} or
\code{http://servername:port/}.}
\item{name}{Optional nickname for the server. If none is given, the nickname
is inferred from the server's hostname.}
\item{certificate}{Optional; a path a certificate file to be used when making
SSL connections to the server. The file's contents are copied and stored by
the \pkg{rsconnect} package. Can also be a character vector containing the
certificate's contents.}
}
\value{
\code{servers} returns a data frame with registered server names and URLs.
\code{serverInfo} returns a list with details for a particular server.
}
\description{
Functions to manage the list of known servers to which
\pkg{rsconnect} can deploy and manage applications.
}
\details{
Register a server with \code{addServer} or \code{discoverServers} (the latter
is useful only if your administrator has configured server autodiscovery).
Once a server is registered, you can connect to an account on the server
using \code{\link[=connectUser]{connectUser()}}.
The \code{servers} and \code{serverInfo} functions are provided for viewing
previously registered servers.
There is always at least one server registered (the \code{shinyapps.io}
server)
}
\examples{
\dontrun{
# register a local server
addServer("http://myrsconnect/", "myserver")
# list servers
servers(local = TRUE)
# connect to an account on the server
connectUser(server = "myserver")
}
}
rsconnect/man/showInvited.Rd 0000644 0001762 0000144 00000001476 13561066365 015640 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/auth.R
\name{showInvited}
\alias{showInvited}
\title{List invited users for an application}
\usage{
showInvited(appDir = getwd(), appName = NULL, account = NULL,
server = NULL)
}
\arguments{
\item{appDir}{Directory containing application. Defaults to
current working directory.}
\item{appName}{Name of application.}
\item{account}{Account name. If a single account is registered on the
system then this parameter can be omitted.}
\item{server}{Server name. Required only if you use the same account name on
multiple servers.}
}
\description{
List invited users for an application
}
\note{
This function works only for ShinyApps servers.
}
\seealso{
\code{\link[=addAuthorizedUser]{addAuthorizedUser()}} and \code{\link[=showUsers]{showUsers()}}
}
rsconnect/man/removeAuthorizedUser.Rd 0000644 0001762 0000144 00000001647 13561066365 017530 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/auth.R
\name{removeAuthorizedUser}
\alias{removeAuthorizedUser}
\title{Remove authorized user from an application}
\usage{
removeAuthorizedUser(user, appDir = getwd(), appName = NULL,
account = NULL, server = NULL)
}
\arguments{
\item{user}{The user to remove. Can be id or email address.}
\item{appDir}{Directory containing application. Defaults to
current working directory.}
\item{appName}{Name of application.}
\item{account}{Account name. If a single account is registered on the
system then this parameter can be omitted.}
\item{server}{Server name. Required only if you use the same account name on
multiple servers.}
}
\description{
Remove authorized user from an application
}
\note{
This function works only for ShinyApps servers.
}
\seealso{
\code{\link[=addAuthorizedUser]{addAuthorizedUser()}} and \code{\link[=showUsers]{showUsers()}}
}
rsconnect/man/unsetProperty.Rd 0000644 0001762 0000144 00000001637 13561066365 016237 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/configureApp.R
\name{unsetProperty}
\alias{unsetProperty}
\title{Unset Application property}
\usage{
unsetProperty(propertyName, appPath = getwd(), appName = NULL,
account = NULL, force = FALSE)
}
\arguments{
\item{propertyName}{Name of property to unset}
\item{appPath}{Directory or file that was deployed. Defaults to current
working directory.}
\item{appName}{Name of application}
\item{account}{Account name. If a single account is registered on the system
then this parameter can be omitted.}
\item{force}{Forcibly unset the property}
}
\description{
Unset a property on currently deployed ShinyApps application (restoring to
its default value)
}
\note{
This function only works for ShinyApps servers.
}
\examples{
\dontrun{
# unset application package cache property to revert to default
unsetProperty("application.package.cache")
}
}
rsconnect/man/deployAPI.Rd 0000644 0001762 0000144 00000002012 13561066365 015146 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/deployAPI.R
\name{deployAPI}
\alias{deployAPI}
\title{Deploy a Plumber API}
\usage{
deployAPI(api, ...)
}
\arguments{
\item{api}{Path to the API project directory. Must contain either
\code{entrypoint.R} or \code{plumber.R}}
\item{...}{Additional arguments to \code{\link[=deployApp]{deployApp()}}.}
}
\description{
Deploys an application consisting of plumber API routes. The given directory
must contain a script returning a \code{plumb} object or a plumber API definition.
}
\details{
Deploy a plumber API definition by either supplying a directory
containing \code{plumber.R} (an API definition) or \code{entrypoint.R} that returns a
\code{plumb} object created by \code{plumber::plumb()}. See the plumber documentation
for more information.
}
\seealso{
Other Deployment functions: \code{\link{applications}},
\code{\link{deployApp}}, \code{\link{deployDoc}},
\code{\link{deploySite}}, \code{\link{deployTFModel}}
}
\concept{Deployment functions}
rsconnect/man/setProperty.Rd 0000644 0001762 0000144 00000001757 13561066365 015677 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/configureApp.R
\name{setProperty}
\alias{setProperty}
\title{Set Application property}
\usage{
setProperty(propertyName, propertyValue, appPath = getwd(),
appName = NULL, account = NULL, force = FALSE)
}
\arguments{
\item{propertyName}{Name of property to set}
\item{propertyValue}{Nalue to set property to}
\item{appPath}{Directory or file that was deployed. Defaults to current
working directory.}
\item{appName}{Name of application}
\item{account}{Account name. If a single account is registered on the system
then this parameter can be omitted.}
\item{force}{Forcibly set the property}
}
\description{
Set a property on currently deployed ShinyApps application.
}
\note{
This function only works for ShinyApps servers.
}
\examples{
\dontrun{
# set instance size for an application
setProperty("application.instances.count", 1)
# disable application package cache
setProperty("application.package.cache", FALSE)
}
}
rsconnect/man/applications.Rd 0000644 0001762 0000144 00000003361 13561066365 016016 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/applications.R
\name{applications}
\alias{applications}
\title{List Deployed Applications}
\usage{
applications(account = NULL, server = NULL)
}
\arguments{
\item{account}{Account name. If a single account is registered on the system
then this parameter can be omitted.}
\item{server}{Server name. Required only if you use the same account name on
multiple servers.}
}
\value{
Returns a data frame with the following columns:
\tabular{ll}{
\code{id} \tab Application unique id \cr
\code{name} \tab Name of application \cr
\code{url} \tab URL where application can be accessed \cr
\code{status} \tab Current status of application. Valid values are \code{pending},
\code{deploying}, \code{running}, \code{terminating}, and \code{terminated} \cr
\code{size} \tab Instance size (small, medium, large, etc.) (on
ShinyApps.io) \cr
\code{instances} \tab Number of instances (on ShinyApps.io) \cr
\code{config_url} \tab URL where application can be configured \cr
}
}
\description{
List all applications currently deployed for a given account.
}
\note{
To register an account you call the \code{\link[=setAccountInfo]{setAccountInfo()}} function.
}
\examples{
\dontrun{
# list all applications for the default account
applications()
# list all applications for a specific account
applications("myaccount")
# view the list of applications in the data viewer
View(applications())
}
}
\seealso{
\code{\link[=deployApp]{deployApp()}}, \code{\link[=terminateApp]{terminateApp()}}
Other Deployment functions: \code{\link{deployAPI}},
\code{\link{deployApp}}, \code{\link{deployDoc}},
\code{\link{deploySite}}, \code{\link{deployTFModel}}
}
\concept{Deployment functions}
rsconnect/man/addLinter.Rd 0000644 0001762 0000144 00000001730 13561066365 015234 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/lint-framework.R
\name{addLinter}
\alias{addLinter}
\title{Add a Linter}
\usage{
addLinter(name, linter)
}
\arguments{
\item{name}{The name of the linter, as a string.}
\item{linter}{A \code{\link[=linter]{linter()}}.}
}
\description{
Add a linter, to be used in subsequent calls to \code{\link[=lint]{lint()}}.
}
\examples{
addLinter("no.capitals", linter(
## Identify lines containing capital letters -- either by name or by index
apply = function(content, ...) {
grep("[A-Z]", content)
},
## Only use this linter on R files (paths ending with .r or .R)
takes = function(paths) {
grep("[rR]$", paths)
},
# Use the default message constructor
message = function(content, lines, ...) {
makeLinterMessage("Capital letters found on the following lines", content, lines)
},
# Give a suggested prescription
suggest = "Do not use capital letters in these documents."
))
}
rsconnect/man/lint.Rd 0000644 0001762 0000144 00000001232 13561066365 014271 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/lint-framework.R
\name{lint}
\alias{lint}
\title{Lint a Project}
\usage{
lint(project, files = NULL, appPrimaryDoc = NULL)
}
\arguments{
\item{project}{Path to a project directory.}
\item{files}{Specific files to lint. Can be NULL, in which case all
the files in the directory will be linted.}
\item{appPrimaryDoc}{The primary file in the project directory. Can be NULL,
in which case it's inferred (if possible) from the directory contents.}
}
\description{
Takes the set of active linters (see \code{\link[=addLinter]{addLinter()}}), and applies
them to all files within a project.
}
rsconnect/man/showUsage.Rd 0000644 0001762 0000144 00000002300 13561066365 015265 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/usage.R
\name{showUsage}
\alias{showUsage}
\title{Show Application Usage}
\usage{
showUsage(appDir = getwd(), appName = NULL, account = NULL,
server = NULL, usageType = "hours", from = NULL, until = NULL,
interval = NULL)
}
\arguments{
\item{appDir}{Directory containing application. Defaults to
current working directory.}
\item{appName}{Name of application}
\item{account}{Account name. If a single account is registered on the
system then this parameter can be omitted.}
\item{server}{Server name. Required only if you use the same account name on
multiple servers.}
\item{usageType}{Use metric to retreive (for example: "hours")}
\item{from}{Date range starting timestamp (Unix timestamp or relative time
delta such as "2d" or "3w").}
\item{until}{Date range ending timestamp (Unix timestamp or relative time
delta such as "2d" or "3w").}
\item{interval}{Summarization interval. Data points at intervals less then this
will be grouped. (Relative time delta e.g. "120s" or "1h" or "30d").}
}
\description{
Show application usage of a currently deployed application
}
\note{
This function only works for ShinyApps servers.
}
rsconnect/man/connectApiUser.Rd 0000644 0001762 0000144 00000002154 13572046105 016241 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/accounts.R
\name{connectApiUser}
\alias{connectApiUser}
\title{Connect Api User Account}
\usage{
connectApiUser(account = NULL, server = NULL, apiKey = NULL,
quiet = FALSE)
}
\arguments{
\item{account}{A name for the account to connect. Optional.}
\item{server}{The server to connect to. Optional if there is only one server
registered.}
\item{apiKey}{The API key used to authenticate the user}
\item{quiet}{Whether or not to show messages and prompts while connecting the
account.}
}
\description{
Connect a user account to the package using an API key for authentication
so that it can be used to deploy and manage
applications on behalf of the account.
}
\details{
This function configures the user to connect using an apiKey in
the http auth headers instead of a token. This is less secure but may
be necessary when the client is behind a proxy or otherwise unable to
authenticate using a token.
}
\seealso{
Other Account functions: \code{\link{accounts}},
\code{\link{connectUser}}, \code{\link{setAccountInfo}}
}
\concept{Account functions}
rsconnect/man/deployDoc.Rd 0000644 0001762 0000144 00000002710 13561066365 015247 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/deployDoc.R
\name{deployDoc}
\alias{deployDoc}
\title{Deploy a Document}
\usage{
deployDoc(doc, ...)
}
\arguments{
\item{doc}{Path to the document to deploy.}
\item{...}{Additional arguments to \code{\link[=deployApp]{deployApp()}}. Do not supply \code{appDir},
\code{appFiles}, or \code{appPrimaryDoc}; these three parameters are automatically
generated by \code{deployDoc} from the document.}
}
\description{
Deploys an application consisting of a single R Markdown document or other
single file (such as an HTML or PDF document).
}
\details{
When deploying an R Markdown document, any files which are required
to render and display the file must be deployed.
This method discovers these additional files using
\code{\link[rmarkdown:find_external_resources]{rmarkdown::find_external_resources()}} from \pkg{rmarkdown}.
If you find that the document is missing dependencies, either specify the
dependencies explicitly in the document (the documentation for
\code{\link[rmarkdown:find_external_resources]{rmarkdown::find_external_resources()}} explains how to do this), or call
\code{\link[=deployApp]{deployApp()}} directly and specify your own file list in the \code{appFiles}
parameter.
}
\seealso{
Other Deployment functions: \code{\link{applications}},
\code{\link{deployAPI}}, \code{\link{deployApp}},
\code{\link{deploySite}}, \code{\link{deployTFModel}}
}
\concept{Deployment functions}
rsconnect/man/tasks.Rd 0000644 0001762 0000144 00000001535 13561066365 014456 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/tasks.R
\name{tasks}
\alias{tasks}
\title{List Tasks}
\usage{
tasks(account = NULL, server = NULL)
}
\arguments{
\item{account}{Account name. If a single account is registered on the system
then this parameter can be omitted.}
\item{server}{Server name. Required only if you use the same account name on
multiple servers (see \code{\link[=servers]{servers()}})}
}
\value{
Returns a data frame with the following columns:
\tabular{ll}{
\code{id} \tab Task id \cr
\code{action} \tab Task action\cr
\code{status} \tab Current task status\cr
\code{created_time} \tab Task creation time\cr
\code{finished_time} \tab Task finished time\cr
}
}
\description{
List Tasks
}
\examples{
\dontrun{
# list tasks for the default account
tasks()
}
}
\seealso{
\code{\link[=taskLog]{taskLog()}}
}
rsconnect/man/writeManifest.Rd 0000644 0001762 0000144 00000002612 13561066370 016143 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/bundle.R
\name{writeManifest}
\alias{writeManifest}
\title{Create a manifest.json describing deployment requirements.}
\usage{
writeManifest(appDir = getwd(), appFiles = NULL,
appPrimaryDoc = NULL, contentCategory = NULL, python = NULL)
}
\arguments{
\item{appDir}{Directory containing the content (Shiny application, R
Markdown document, etc).}
\item{appFiles}{Optional. The full set of files and directories to be
included in future deployments of this content. Used when computing
dependency requirements. When \code{NULL}, all files in \code{appDir} are
considered.}
\item{appPrimaryDoc}{Optional. Specifies the primary document in a content
directory containing more than one. If \code{NULL}, the primary document is
inferred from the file list.}
\item{contentCategory}{Optional. Specifies the kind of content being
deployed (e.g. \code{"plot"} or \code{"site"}).}
\item{python}{Full path to a python binary for use by \code{reticulate}.
The specified python binary will be invoked to determine its version
and to list the python packages installed in the environment.
If python = NULL, and RETICULATE_PYTHON is set in the environment,
its value will be used.}
}
\description{
Given a directory content targeted for deployment, write a manifest.json
into that directory describing the deployment requirements for that
content.
}
rsconnect/man/taskLog.Rd 0000644 0001762 0000144 00000001452 13561066365 014733 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/tasks.R
\name{taskLog}
\alias{taskLog}
\title{Show task log}
\usage{
taskLog(taskId, account = NULL, server = NULL, output = NULL)
}
\arguments{
\item{taskId}{Task Id}
\item{account}{Account name. If a single account is registered on the system
then this parameter can be omitted.}
\item{server}{Server name. Required only if you use the same account name on
multiple servers (see \code{\link[=servers]{servers()}})}
\item{output}{Where to write output. Valid values are \code{NULL} or \code{stderr}}
}
\description{
Writes the task log for the given task
}
\examples{
\dontrun{
# write task log to stdout
taskLog(12345)
# write task log to stderr
taskLog(12345, output="stderr")
}
}
\seealso{
\code{\link[=tasks]{tasks()}}
}
rsconnect/man/linter.Rd 0000644 0001762 0000144 00000002533 13561066365 014625 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/lint-framework.R
\name{linter}
\alias{linter}
\title{Create a Linter}
\usage{
linter(apply, takes, message, suggestion)
}
\arguments{
\item{apply}{Function that, given the content of a file, returns the indices
at which problems were found.}
\item{takes}{Function that, given a set of paths, returns the subset of
paths that this linter uses.}
\item{message}{Function that, given content and lines, returns an
informative message for the user. Typically generated with
\code{\link[=makeLinterMessage]{makeLinterMessage()}}.}
\item{suggestion}{String giving a prescribed fix for the linted problem.}
}
\description{
Generate a linter, which can identify errors or problematic regions in a
project.
}
\examples{
addLinter("no.capitals", linter(
## Identify lines containing capital letters -- either by name or by index
apply = function(content, ...) {
grep("[A-Z]", content)
},
## Only use this linter on R files (paths ending with .r or .R)
takes = function(paths) {
grep("[rR]$", paths)
},
# Use the default message constructor
message = function(content, lines, ...) {
makeLinterMessage("Capital letters found on the following lines", content, lines)
},
# Give a suggested prescription
suggest = "Do not use capital letters in these documents."
))
}
rsconnect/man/figures/ 0000755 0001762 0000144 00000000000 13561066365 014502 5 ustar ligges users rsconnect/man/figures/logo.png 0000644 0001762 0000144 00000074143 13561066365 016161 0 ustar ligges users PNG
IHDR r LqG sBIT|d pHYs + tEXtSoftware www.inkscape.org< IDATxy|T?9Βd} ""bD~Ubmk]j[?~OhVpU*
a]BCȾOfc&Ȅ$N̹ : uJ,nYP(q>O4pEDDDDDDK
yRAP?)KBkW<҈1w"sg'u- }.Q,+>h(l;g'(; .
ո}q$TuQ1wl-4 673*e˖^uiB!wR5K|6Q``n6mfSo bpM)oxÕ_DDDDDDS&x ipZrއBM :[iR 遅~}!Df1Ve#DDDDDDG#]m@ۦGCf^(*§}{/BJ)j>{1DDDDDDnhUW<hga'ښ?4JRqM-_-(<#ԩS1֗
*)RrŕgBʳ7v̯JEWeJ<hF\N'^x)lݸJ BsUwZ+/0t^hۤcm~ Jaٲe!)ߎn9GJBhG@R.(Ӊy
[6.?.hՂFDDDDDDcosg'u- }m?0dvAcZ!~x^͟=;F9pimu]ǵ?ko拕XBT״K~kʶyb
9o j)L;XTiW^4۴ڨ-[
QDDDDDD u[L` {^!bSO`
j-xsbMh[#?0I(-$؇OyUP7ʯCP5zt Su\1Z|]!.>}=,[*ڀ
vK_z{UüYB=,4,?ѡ*ݘE_J6_ ěMcHDDDDDtbogMx
ɁMIM}<̞BPYxcO7VR
Z^~eDDDDDD. ̿ꪾ5] #mk-wS_"ˮ>Ҷ4?k~`EDDDDDt!boS3b/K$\q%nٽ2ᄒ-Ϳ*s^ݦ""""""b?[f_k 쁶