File: model-classes.Rd

package info (click to toggle)
r-cran-bayesfactor 0.9.12-4.7%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,492 kB
  • sloc: cpp: 1,555; sh: 16; makefile: 7
file content (29 lines) | stat: -rw-r--r-- 1,389 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/aaClasses.R
\docType{class}
\name{BFmodel-class}
\alias{BFmodel-class}
\alias{BFcorrelation-class}
\alias{BFproportion-class}
\alias{BFcontingencyTable-class}
\alias{BFlinearModel-class}
\alias{BFoneSample-class}
\alias{BFindepSample-class}
\title{General S4 classes for representing models for comparison}
\description{
The \code{BFmodel} is a general S4 class for representing models for comparison. The more classes
\code{BFlinearModel}, \code{BFindepSample}, and \code{BFoneSample} inherit directly from \code{BFmodel}.
}
\details{
\describe{
  These model classes all have the following slots defined:
   \item{type}{Model type}
   \item{identifier}{a list uniquely identifying the model from other models of the same type}
   \item{prior}{list giving appropriate prior settings for the model}
   \item{dataTypes}{a character vector whose names are possible columns in the data; elements specify the corresponding data type, currently one of c("fixed","random","continuous")}
   \item{shortName}{a short, readable identifying string}
   \item{longName}{a longer, readable identifying string}
   \item{analysis}{object storing information about a previous analysis of this model}
   \item{version}{character string giving the version and revision number of the package that the model was created in}
   }
}