]> git.elephly.net Git - software/r-guix-install.git/blob - man/guix.install.Rd
Add minimal R package files and directories.
[software/r-guix-install.git] / man / guix.install.Rd
1 \name{guix.install}
2 \alias{guix.install}
3 \encoding{UTF-8}
4 \title{guix.install}
5 \description{
6 This procedure installs a given package with Guix. If the package is
7 available in any enabled Guix channel, the package and its
8 dependencies will be installed from there.
9
10 If the package is not available in Guix the procedure attempts to
11 generate a package definition by recursively importing metadata from
12 CRAN, Bioconductor, or a git/mercurial repository. Upon successful
13 generation of package definitions in \code{~/.Rguix/packages.scm} the
14 package is installed with Guix.
15
16 The file \code{~/.Rguix/packages.scm} is only appended to for
17 reproducibility reasons. Each entry has a comment with a timestamp
18 for convenience. The package definitions in that file could be
19 upstreamed to a Guix channel to make it easier for others to reproduce
20 the environment. Consider sending package definitions to either the
21 \href{https://guix.gnu.org/en/contribute/}{Guix project} or the
22 \href{https://github.com/guix-science/guix-science}{Guix Science project}.
23 }
24 \usage{
25 guix.install(package, profile = NULL, guix = "guix", archive = NULL)
26 }
27 \arguments{
28 \item{package}{
29 The name of the R package to be installed as used on CRAN or
30 Bioconductor, or a HTTP URL of a git repository holding an R
31 package.
32 }
33 \item{profile}{
34 The target Guix profile where the package should be installed. By
35 default this is the default Guix profile at
36 \code{$HOME/.guix-profile}.
37 }
38 \item{guix}{
39 The absolute file name of the \code{guix} executable. By default
40 this is just \code{guix} and will be searched on the user's \code{PATH}.
41 }
42 \item{archive}{
43 This argument is used to override the Guix importer's \code{archive}
44 option, e.g. to explicitly specify that the package should be imported
45 from Bioconductor or from a Mercurial repository.
46 }
47 }
48 \value{
49 This procedure is run for its side-effects.
50 }
51 \author{
52 Ricardo Wurmus, \email{ricardo.wurmus@mdc-berlin.de}
53 }
54
55 \examples{
56 \dontrun{
57 guix.install("methylKit")
58 guix.install("methylKit", profile="/home/foo/custom/.guix-profile")
59 guix.install("methylKit", guix="/gnu/remote/bin/guix")
60 }
61 }
62
63 \keyword{ utilities }
64 \concept{ package management }
65 \concept{ reproducibility }