File: fmclass.Rd

package info (click to toggle)
r-cran-fit.models 0.64-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 364 kB
  • sloc: sh: 13; makefile: 2
file content (37 lines) | stat: -rw-r--r-- 1,102 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/fmclass.register.R
\name{fmclass.register}
\alias{fmclass.register}
\alias{fmclass.add.class}
\title{Register Comparable Functions}
\usage{
fmclass.register(fmclass, classes, validation.function = NULL)

fmclass.add.class(fmclass, class, warn = TRUE)
}
\arguments{
\item{fmclass}{a character string naming the fit.models class to be added.}

\item{classes}{a character vector naming one or more classes that can be
compared by the methods defined for the fit.models class in \code{fmclass}.}

\item{validation.function}{a function returning \code{TRUE} when the models
are comparable.}

\item{class}{a character string specifying a class compatible with the
methods of \code{fmclass}.}

\item{warn}{a logical value. If TRUE, a warning is printed if \code{class}
is already registered.}
}
\value{
a null value is invisibly returned.
}
\description{
The \code{fit.models} package maintains a list of comparable models.
These functions provide an api to modify this list.
}
\details{
See the package vignette.
}
\keyword{misc}