File: BFprobability-class.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 (51 lines) | stat: -rw-r--r-- 1,776 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/aaClasses.R, R/methods-BFprobability.R
\docType{class}
\name{BFprobability-class}
\alias{BFprobability-class}
\alias{/,BFprobability,numeric-method}
\alias{-,BFprobability,numeric-method}
\alias{[,BFprobability,index,missing,missing-method}
\alias{filterBF,BFprobability,character-method}
\title{General S4 class for representing multiple model probability comparisons}
\usage{
\S4method{/}{BFprobability,numeric}(e1, e2)

\S4method{-}{BFprobability,numeric}(e1, e2)

\S4method{[}{BFprobability,index,missing,missing}(x, i, j, ..., drop = TRUE)

\S4method{filterBF}{BFprobability,character}(x, name, perl = FALSE, fixed = FALSE, ...)
}
\arguments{
\item{e1}{BFprobability object}

\item{e2}{new normalization constant}

\item{x}{BFprobability object}

\item{i}{indices indicating elements to extract}

\item{j}{unused for BFprobability objects}

\item{...}{further arguments passed to related methods}

\item{drop}{unused}

\item{name}{regular expression to search name}

\item{perl}{logical. Should perl-compatible regexps be used? See ?grepl for details.}

\item{fixed}{logical. If TRUE, pattern is a string to be matched as is. See ?grepl for details.}
}
\description{
The \code{BFprobability} class is a general S4 class for representing models model comparison via prior or posterior probabilities.
}
\details{
\describe{
  The \code{BFprobability} class has the following slots defined:
   \item{odds}{A BFodds object containing the models from which to compute the probabilities}
   \item{normalize}{the sum of the probabilities of all models (will often be 1.0)}
   \item{version}{character string giving the version and revision number of the package that the model was created in}
   }
}