File: has.partial.auc.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 (56 lines) | stat: -rw-r--r-- 1,121 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
\encoding{UTF-8}
\name{has.partial.auc}
\alias{has.partial.auc}
\alias{has.partial.auc.smooth.roc}
\alias{has.partial.auc.auc}
\alias{has.partial.auc.roc}

\title{
  Does the ROC curve have a partial AUC?
}
\description{
  This function determines if the ROC curve has a partial AUC.
}
\usage{
has.partial.auc(roc)
\S3method{has.partial.auc}{auc}(roc)
\S3method{has.partial.auc}{smooth.roc}(roc)
\S3method{has.partial.auc}{roc}(roc)
}
		   
\arguments{
  \item{roc}{the ROC curve to check.}
}

\value{
  \code{TRUE} if the AUC is a partial AUC, \code{FALSE} otherwise.

  If the AUC is not defined (i. e. if roc was called with \code{AUC=FALSE}), returns \code{NULL}.
}

\seealso{
\code{\link{auc}}
}

\examples{
data(aSAH)

# Full AUC
roc1 <- roc(aSAH$outcome, aSAH$s100b)
has.partial.auc(roc1)
has.partial.auc(auc(roc1))
has.partial.auc(smooth(roc1))

# Partial AUC
roc2 <- roc(aSAH$outcome, aSAH$s100b, partial.auc = c(1, 0.9))
has.partial.auc(roc2)
has.partial.auc(smooth(roc2))

# No AUC
roc3 <- roc(aSAH$outcome, aSAH$s100b, auc = FALSE)
has.partial.auc(roc3)
}

\keyword{programming}
\keyword{logic}
\keyword{roc}