File: pkgman_describe.Rd

package info (click to toggle)
r-cran-svmisc 1.4.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 844 kB
  • sloc: sh: 12; makefile: 2
file content (118 lines) | stat: -rw-r--r-- 2,631 bytes parent folder | download
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/pkgMan.R
\name{pkgman_describe}
\alias{pkgman_describe}
\alias{pkgman_get_mirrors}
\alias{pkgman_get_available}
\alias{pkgman_get_installed}
\alias{pkgman_set_cran_mirror}
\alias{pkgman_install}
\alias{pkgman_remove}
\alias{pkgman_load}
\alias{pkgman_detach}
\alias{pkgManDescribe}
\alias{pkgManGetMirrors}
\alias{pkgManGetAvailable}
\alias{pkgManGetInstalled}
\alias{pkgManSetCRANMirror}
\alias{pkgManInstall}
\alias{pkgManRemove}
\alias{pkgManLoad}
\alias{pkgManDetach}
\title{Functions to manage R side of the SciViews R package manager}
\usage{
pkgman_describe(pkgname, print.it = TRUE)

pkgman_get_mirrors()

pkgman_get_available(
  page = "next",
  pattern = "",
  n = 50,
  keep = c("Package", "Version", "InstalledVersion", "Status"),
  reload = FALSE,
  sep = ";",
  eol = "\\t\\n"
)

pkgman_get_installed(sep = ";", eol = "\\t\\n")

pkgman_set_cran_mirror(url)

pkgman_install(pkgs, install.deps = FALSE, ask = TRUE)

pkgman_remove(pkgname)

pkgman_load(pkgname)

pkgman_detach(pkgname)

pkgManDescribe(pkgname, print.it = TRUE)

pkgManGetMirrors()

pkgManGetAvailable(
  page = "next",
  pattern = "",
  n = 50,
  keep = c("Package", "Version", "InstalledVersion", "Status"),
  reload = FALSE,
  sep = ";",
  eol = "\\t\\n"
)

pkgManGetInstalled(sep = ";", eol = "\\t\\n")

pkgManSetCRANMirror(url)

pkgManInstall(pkgs, install.deps = FALSE, ask = TRUE)

pkgManRemove(pkgname)

pkgManLoad(pkgname)

pkgManDetach(pkgname)
}
\arguments{
\item{pkgname}{The name of one R package (character string).}

\item{print.it}{Should the result be printed?}

\item{page}{Which page to get?}

\item{pattern}{Selection pattern.}

\item{n}{The number of items to retrieve.}

\item{keep}{The columns to keep in the resulting data frame.}

\item{reload}{Do we force reload of the data and ignore cache version?}

\item{sep}{Field separator to use.}

\item{eol}{End-of-line sequence to use.}

\item{url}{The URL to use for the current CRAN mirror.}

\item{pkgs}{A list of packages to install.}

\item{install.deps}{Do we also install dependencies?}

\item{ask}{Do we prompt the user for package installation?}
}
\value{
These functions return data that is intended to be used by the
SciViews \R package manager.
}
\description{
These functions should not be used directly by the end-user.
They implement the R-side code for the SciViews \R package manager.
}
\seealso{
\code{\link[=package]{package()}}
}
\author{
Kamil Barton \href{mailto:kamil.barton@uni-wuerzburg.de}{kamil.barton@uni-wuerzburg.de}
}
\concept{SciViews R package manager}
\keyword{utilities}