File: groupGeneric.Rd

package info (click to toggle)
r-cran-proc 1.18.5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,260 kB
  • sloc: cpp: 144; sh: 14; makefile: 2
file content (72 lines) | stat: -rw-r--r-- 1,502 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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
\encoding{UTF-8}
\name{groupGeneric}
\alias{groupGeneric}
\alias{groupGeneric.pROC}
\alias{groupGeneric.auc}
\alias{groupGeneric.ci.coords}
\alias{groupGeneric.ci.se}
\alias{groupGeneric.ci.sp}
\alias{Ops}
\alias{Math}
\alias{Ops.auc}
\alias{Math.auc}
\alias{Ops.ci.coords}
\alias{Math.ci.coords}
\alias{Ops.ci.se}
\alias{Math.ci.se}
\alias{Ops.ci.sp}
\alias{Math.ci.sp}
\alias{Ops.ci.auc}
\alias{Math.ci.auc}
\alias{Ops.ci}
\alias{Math.ci}


\title{
  pROC Group Generic Functions
}
\description{
  Redefine \pkg{base} groupGeneric functions to handle \code{\link{auc}} and \code{\link{ci}} objects properly on operations and mathematical operations.
  Attributes are dropped so that the AUC/CI behaves as a numeric value/matrix, respectively.
  In the case of AUC, all attributes are dropped, while in CI only the CI-specific attributes are, keeping those necessary for the matrices.
}
\usage{
\special{Math(x, \dots)}
\special{Ops(e1, e2)}
}
		   
\arguments{
  \item{x, e1, e2}{\code{\link{auc}} objects, or mixed numerics and \code{auc} objects.
  }
  \item{\dots}{further arguments passed to other Math methods.
  }
}


\seealso{
\code{\link{groupGeneric}}, \code{\link{auc}}
}
\examples{
data(aSAH)

# Create a roc object:
aucobj1 <- auc(roc(aSAH$outcome, aSAH$s100b))
aucobj2 <- auc(roc(aSAH$outcome, aSAH$wfns))

# Math
sqrt(aucobj1)
round(aucobj2, digits=1)

# Ops
aucobj1 * 2
2 * aucobj2
aucobj1 + aucobj2

# With CI
ciaucobj <- ci(aucobj1)
ciaucobj * 2
sqrt(ciaucobj)

}

\keyword{methods}