File: forgetDeployment.Rd

package info (click to toggle)
r-cran-rsconnect 1.3.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,044 kB
  • sloc: python: 185; sh: 13; makefile: 5
file content (47 lines) | stat: -rw-r--r-- 1,384 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/deployments.R
\name{forgetDeployment}
\alias{forgetDeployment}
\title{Forget Application Deployment}
\usage{
forgetDeployment(
  appPath = getwd(),
  name = NULL,
  account = NULL,
  server = NULL,
  dryRun = FALSE,
  force = !interactive()
)
}
\arguments{
\item{appPath}{The path to the content that was deployed, either a directory
or an individual document.}

\item{name}{The name of the content that was deployed (optional)}

\item{account}{The name of the account to which the content was deployed
(optional)}

\item{server}{The name of the server to which the content was deployed
(optional)}

\item{dryRun}{Set to TRUE to preview the files/directories to be removed
instead of actually removing them. Defaults to FALSE.}

\item{force}{Set to TRUE to remove files and directories without prompting.
Defaults to FALSE in interactive sessions.}
}
\value{
NULL, invisibly.
}
\description{
Forgets about an application deployment. This is useful if the application
has been deleted on the server, or the local deployment information needs to
be reset.
}
\details{
This method removes from disk the file containing deployment
metadata. If "name", "account", and "server" are all NULL, then all of the
deployments for the application are forgotten; otherwise, only the
specified deployment is forgotten.
}