File: getTypeStrings.Rd

package info (click to toggle)
r-cran-paramhelpers 1.14.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 992 kB
  • sloc: ansic: 102; sh: 13; makefile: 2
file content (42 lines) | stat: -rw-r--r-- 994 bytes parent folder | download | duplicates (3)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/getTypeStrings.R
\name{getTypeStrings}
\alias{getTypeStrings}
\alias{getTypeStringsAll}
\alias{getTypeStringsNumeric}
\alias{getTypeStringsNumericStrict}
\alias{getTypeStringsInteger}
\alias{getTypeStringsCharacter}
\alias{getTypeStringsDiscrete}
\alias{getTypeStringsLogical}
\title{Get parameter type-strings.}
\usage{
getTypeStringsAll()

getTypeStringsNumeric(include.int = TRUE)

getTypeStringsNumericStrict()

getTypeStringsInteger()

getTypeStringsCharacter()

getTypeStringsDiscrete(include.logical = TRUE)

getTypeStringsLogical()
}
\arguments{
\item{include.int}{(\code{logical(1)})\cr
Are integers also considered to be numeric?
Default is \code{TRUE}.}

\item{include.logical}{(\code{logical(1)})\cr
Are logicals also considered to be discrete?
Default is \code{TRUE}.}
}
\value{
\code{\link{character}}.
}
\description{
Returns type strings used in \code{param$type} for certain groups of parameters.
}