File: getDescriptionFile.Package.Rd

package info (click to toggle)
r-cran-r.oo 1.21.0-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 1,796 kB
  • sloc: sh: 18; makefile: 2
file content (40 lines) | stat: -rwxr-xr-x 1,103 bytes parent folder | download | duplicates (5)
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
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  Package.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{getDescriptionFile.Package}
\alias{getDescriptionFile.Package}
\alias{Package.getDescriptionFile}
\alias{getDescriptionFile,Package-method}

\title{Gets the description file of this package}

\description{
  Gets the description file of this package, i.e. the parsed \code{DESCRIPTION} file.
}

\usage{
\method{getDescriptionFile}{Package}(this, fields=NULL, ...)
}

\arguments{
  \item{fields}{A \code{\link[base]{vector}} of \code{\link[base]{character}} strings of fields to be returned.
    If \code{\link[base]{NULL}}, all available fields are returned.}
  \item{...}{Not used.}
}

\value{
  Returns named \code{\link[base]{vector}} of \code{\link[base]{character}} strings.
}

\author{Henrik Bengtsson}

\seealso{
  For more information see \code{\link{Package}}.
}
\keyword{internal}
\keyword{methods}