From 459ce96fa8a0072d3533bc2dc1566cc1b797401b Mon Sep 17 00:00:00 2001
From: Gertjan van den Burg <gertjanvandenburg@gmail.com>
Date: Wed, 4 Apr 2018 15:08:12 -0400
Subject: Documentation improvements

---
 R/gensvm.accuracy.R | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'R/gensvm.accuracy.R')

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>
-- 
cgit v1.2.3