summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2017-01-31 07:42:39 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2017-01-31 07:42:39 +0100
commit2454dd9077f1d499549791a774687f12c87aeb8e (patch)
tree93c2cb98027af9b60e6731353897674e5a25faad
parent5cf14fe9a9fe15e866529ebde14492b56645f6b7 (diff)
Document all arguments of install_PELMO
-rw-r--r--R/install_PELMO.R1
-rw-r--r--docs/reference/install_PELMO.html2
-rw-r--r--man/install_PELMO.Rd2
3 files changed, 5 insertions, 0 deletions
diff --git a/R/install_PELMO.R b/R/install_PELMO.R
index 02b1064..18efb81 100644
--- a/R/install_PELMO.R
+++ b/R/install_PELMO.R
@@ -2,6 +2,7 @@
#'
#' @importFrom clipr write_clip
#' @param version The FOCUS PELMO version to install
+#' @param local_zip Do not download, but use the local zip archive specified here
#' @export
install_PELMO <- function(version = "5.5.3", local_zip = NULL) {
pkg_dir <- system.file(package = "PELMO.installeR")
diff --git a/docs/reference/install_PELMO.html b/docs/reference/install_PELMO.html
index 621a2d4..1f83be8 100644
--- a/docs/reference/install_PELMO.html
+++ b/docs/reference/install_PELMO.html
@@ -79,6 +79,8 @@
<dl class="dl-horizontal">
<dt>version</dt>
<dd>The FOCUS PELMO version to install</dd>
+ <dt>local_zip</dt>
+ <dd>Do not download, but use the local zip archive specified here</dd>
</dl>
diff --git a/man/install_PELMO.Rd b/man/install_PELMO.Rd
index 1bca1bb..e4acd5c 100644
--- a/man/install_PELMO.Rd
+++ b/man/install_PELMO.Rd
@@ -8,6 +8,8 @@ install_PELMO(version = "5.5.3", local_zip = NULL)
}
\arguments{
\item{version}{The FOCUS PELMO version to install}
+
+\item{local_zip}{Do not download, but use the local zip archive specified here}
}
\description{
Download FOCUS PELMO from the official site and unzip into the package installation directory

Contact - Imprint