File: capabilitiesOf.RRspPackage.Rd

package info (click to toggle)
r-cran-r.rsp 0.45.0%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 2,568 kB
  • sloc: javascript: 612; tcl: 304; sh: 18; makefile: 16
file content (56 lines) | stat: -rw-r--r-- 1,572 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
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  999.RRspPackage.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{RRspPackage$capabilitiesOf}
\alias{RRspPackage$capabilitiesOf}
\alias{capabilitiesOf.RRspPackage}
\alias{RRspPackage.capabilitiesOf}
\alias{capabilitiesOf,RRspPackage-method}
\alias{RRspPackage.isCapableOf}
\alias{isCapableOf.RRspPackage}
\alias{isCapableOf,RRspPackage-method}


\title{Checks which tools are supported}

\description{
  Checks which tools are supported.
}

\usage{
## Static method (use this):
## RRspPackage$capabilitiesOf(what=NULL, force=FALSE, ...)

## Don't use the below:
\method{capabilitiesOf}{RRspPackage}(static, what=NULL, force=FALSE, ...)
}

\arguments{
 \item{what}{Optional \code{\link[base]{character}} \code{\link[base]{vector}} of which tools to check.}
 \item{force}{If \code{\link[base:logical]{TRUE}}, cached results are ignored, otherwise not.}
 \item{...}{Not used.}
}

\value{
  Returns a \code{\link[base]{logical}} named \code{\link[base]{character}} \code{\link[base]{vector}}.
}

\examples{
  # Display which tools are supported by the package
  print(capabilitiesOf(R.rsp))

  # Check whether AsciiDoc is supported
  print(isCapableOf(R.rsp, "asciidoc"))

  # Check whether pandoc v1.12 or newer is supported
  print(isCapableOf(R.rsp, "pandoc (>= 1.12)"))
}

\author{Henrik Bengtsson}
\keyword{internal}
\keyword{methods}