File: quickinstall.Rd

package info (click to toggle)
r-cran-pkgmaker 0.32.10-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,192 kB
  • sloc: sh: 13; makefile: 2
file content (44 lines) | stat: -rw-r--r-- 1,351 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/packages.R
\name{quickinstall}
\alias{quickinstall}
\title{Quick Installation of a Source Package}
\usage{
quickinstall(
  path,
  destdir = NULL,
  vignettes = FALSE,
  force = TRUE,
  ...,
  lib.loc = if (!is.null(destdir)) TRUE
)
}
\arguments{
\item{path}{path to the package source directory}

\item{destdir}{installation directory.
If \code{NULL}, the package is installed in the default installation library.
If \code{NA}, the package is installed in a temporary directory, whose path is returned
as a value.}

\item{vignettes}{logical that indicates if the vignettes should be
rebuilt and installed.}

\item{force}{logical that indicates if the package should be installed even if a previous
installation exists in the installation library.}

\item{...}{extra arguments passed to \code{\link{R.CMD}}}

\item{lib.loc}{library specification.
If \code{TRUE} then the installation directory \code{destdir} is added to the default
library paths.
This can be usefull if dependencies are installed in this directory.
If \code{NULL}, then the default library path is left unchanged.}
}
\value{
\code{quickinstall} returns the path of the library where the package was installed.
}
\description{
Builds and install a minimal version of a package from its
source directory.
}