Merge pull request #31 from ModelOriented/dev

minor documentation fix
ModelOriented · Oct 22, 2020 · 5cd0c55 · 5cd0c55
2 parents 180b21e + 44ef7f8
commit 5cd0c55
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 18 deletions.
diff --git a/R/all_cutoffs.R b/R/all_cutoffs.R
@@ -38,7 +38,7 @@
 
 all_cutoffs <- function(x,
                         grid_points = 101,
-                        fairness_metrics = fairness_check_metrics()){
+                        fairness_metrics = c('ACC', 'TPR', 'PPV', 'FPR', 'STP')){
 
   stopifnot(class(x) == "fairness_object")
 

diff --git a/R/choose_metric.R b/R/choose_metric.R
@@ -1,10 +1,10 @@
 #' Choose metric
 #'
 #' Extracts metrics from \code{metric_data} from fairness object.
-#' It allows to visualize and compare chosen metric values across all models.
+#' It allows to visualize and compare parity loss of chosen metric values across all models.
 #'
 #' @param x object of class \code{fairness_object}
-#' @param fairness_metric \code{char}, name of fairness metric, one of metrics:
+#' @param fairness_metric \code{char}, single name of metric, one of metrics:
 #'
 #' \itemize{
 #'

diff --git a/man/all_cutoffs.Rd b/man/all_cutoffs.Rd
diff --git a/man/choose_metric.Rd b/man/choose_metric.Rd
diff --git a/man/figures/preview.gif b/man/figures/preview.gif