Commit e35cca78 authored by fvafrcu's avatar fvafrcu

fix docs

parent 91d8c3cd
Pipeline #102710591 passed with stages
in 15 minutes and 22 seconds
......@@ -10,7 +10,8 @@ Description: An S4 implementation of Eq. (3) and Eq. (7) by David J. Hand and
Robert J. Till (2001) <DOI:10.1023/A:1010920819831>.
URL: https://gitlab.com/fvafrCU/HandTill2001
Depends:
R (>= 2.14),
R (>= 2.14)
Imports:
methods,
utils
Suggests:
......
......@@ -26,11 +26,10 @@
#'
#'
#' @export bincap
bincap <-
function (response, predicted, true = "1")
{
return(methods::new(Class = "bincap", response = response, predicted = predicted,
true = true))
bincap <- function (response, predicted, true = "1") {
new <- methods::new(Class = "bincap", response = response,
predicted = predicted, true = true)
return(new)
}
......@@ -62,8 +61,8 @@ function (response, predicted, true = "1")
#'
#'
#' @export multcap
multcap <-
function (response, predicted)
{
return(new(Class = "multcap", response = response, predicted = predicted))
multcap <- function (response, predicted) {
new <- methods::new(Class = "multcap", response = response,
predicted = predicted)
return(new)
}
......@@ -9,11 +9,16 @@
#' @name ht01.multipleclass
#' @docType data
#' @format A data frame with 214 observations on the following 7 variables.
#' \describe{ \item{list("observed")}{a factor with levels \code{Con}
#' \code{Head} \code{Tabl} \code{Veh} \code{WinF} \code{WinNF}}
#' \item{list("WinF")}{a numeric vector} \item{list("WinNF")}{a numeric vector}
#' \item{list("Veh")}{a numeric vector} \item{list("Con")}{a numeric vector}
#' \item{list("Tabl")}{a numeric vector} \item{list("Head")}{a numeric vector}
#' \describe{
#' \item{observed}{a factor with levels
#' \code{Con} \code{Head} \code{Tabl} \code{Veh}
#' \code{WinF} \code{WinNF}}
#' \item{WinF}{a numeric vector}
#' \item{WinNF}{a numeric vector}
#' \item{Veh}{a numeric vector}
#' \item{Con}{a numeric vector}
#' \item{Tabl}{a numeric vector}
#' \item{Head}{a numeric vector}
#' }
#' @references Venables, W. N and Ripley, B. D. (2002), \emph{Modern Applied
#' Statistics with S} (4th edition). Springer, ISBN 0-387-95457-0
......@@ -45,8 +50,8 @@ NULL
#' @name ht01.twoclass
#' @docType data
#' @format A data frame with 189 observations on the following 2 variables.
#' \describe{ \item{list("observed")}{a numeric vector}
#' \item{list("predicted")}{a numeric vector} }
#' \describe{ \item{observed}{a numeric vector}
#' \item{predicted}{a numeric vector} }
#' @references Venables, W. N and Ripley, B. D. (2002), \emph{Modern Applied
#' Statistics with S} (4th edition). Springer, ISBN 0-387-95457-0
#' @source \preformatted{ ## From: A two class data example Venables and Ripley
......
......@@ -5,11 +5,16 @@
\alias{ht01.multipleclass}
\title{ht01.multipleclass data in Package \pkg{HandTill2001}}
\format{A data frame with 214 observations on the following 7 variables.
\describe{ \item{list("observed")}{a factor with levels \code{Con}
\code{Head} \code{Tabl} \code{Veh} \code{WinF} \code{WinNF}}
\item{list("WinF")}{a numeric vector} \item{list("WinNF")}{a numeric vector}
\item{list("Veh")}{a numeric vector} \item{list("Con")}{a numeric vector}
\item{list("Tabl")}{a numeric vector} \item{list("Head")}{a numeric vector}
\describe{
\item{observed}{a factor with levels
\code{Con} \code{Head} \code{Tabl} \code{Veh}
\code{WinF} \code{WinNF}}
\item{WinF}{a numeric vector}
\item{WinNF}{a numeric vector}
\item{Veh}{a numeric vector}
\item{Con}{a numeric vector}
\item{Tabl}{a numeric vector}
\item{Head}{a numeric vector}
}}
\source{
\preformatted{ ## From: Forensic glass example Venables and Ripley
......
......@@ -5,8 +5,8 @@
\alias{ht01.twoclass}
\title{ht01.twoclass data in Package \pkg{HandTill2001}}
\format{A data frame with 189 observations on the following 2 variables.
\describe{ \item{list("observed")}{a numeric vector}
\item{list("predicted")}{a numeric vector} }}
\describe{ \item{observed}{a numeric vector}
\item{predicted}{a numeric vector} }}
\source{
\preformatted{ ## From: A two class data example Venables and Ripley
pp. 194--199 library(MASS); data("birthwt"); attach(birthwt) race <-
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment