File: getCapabilities.Rd

package info (click to toggle)
r-cran-glmmtmb 1.1.10%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 7,124 kB
  • sloc: cpp: 1,506; sh: 16; makefile: 13
file content (23 lines) | stat: -rw-r--r-- 874 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/family.R
\name{getCapabilities}
\alias{getCapabilities}
\title{List model options that glmmTMB knows about}
\usage{
getCapabilities(what = "all", check = FALSE)
}
\arguments{
\item{what}{(character) which type of model structure to report on
("all","family","link","covstruct")}

\item{check}{(logical) do brute-force checking to test whether families are really implemented (only available for \code{what="family"})}
}
\value{
if \code{check==FALSE}, returns a vector of the names (or a list of name vectors) of allowable entries; if \code{check==TRUE}, returns a logical vector of working families
}
\description{
List model options that glmmTMB knows about
}
\note{
these are all the options that are \emph{defined} internally; they have not necessarily all been \emph{implemented} (FIXME!)
}