diff options
| author | Gertjan van den Burg <gertjanvandenburg@gmail.com> | 2018-04-04 15:08:12 -0400 |
|---|---|---|
| committer | Gertjan van den Burg <gertjanvandenburg@gmail.com> | 2018-04-04 15:08:12 -0400 |
| commit | 459ce96fa8a0072d3533bc2dc1566cc1b797401b (patch) | |
| tree | 229a5d9b137f7fcf3b5112e4a189e972d6dafa26 /R/gensvm.accuracy.R | |
| parent | Ensure classes isn't a factor (diff) | |
| download | rgensvm-459ce96fa8a0072d3533bc2dc1566cc1b797401b.tar.gz rgensvm-459ce96fa8a0072d3533bc2dc1566cc1b797401b.zip | |
Documentation improvements
Diffstat (limited to 'R/gensvm.accuracy.R')
| -rw-r--r-- | R/gensvm.accuracy.R | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/R/gensvm.accuracy.R b/R/gensvm.accuracy.R index c762dd7..387c2db 100644 --- a/R/gensvm.accuracy.R +++ b/R/gensvm.accuracy.R @@ -1,8 +1,13 @@ #' @title Compute the accuracy score #' +#' @description Compute the accuracy score between the true labels and the +#' predicted labels. +#' #' @param y.true vector of true labels #' @param y.pred vector of predicted labels #' +#' @return The accuracy as a value in the range [0.0, 1.0] +#' #' @author #' Gerrit J.J. van den Burg, Patrick J.F. Groenen \cr #' Maintainer: Gerrit J.J. van den Burg <gertjanvandenburg@gmail.com> |