docs solve #22

DESCRIPTION

@@ -7,7 +7,7 @@ Authors@R:
              email = "[email protected]"),
       person("Przemysław", "Biecek", role = c("aut"), 
              comment = c(ORCID = "0000-0001-8423-1823")))
-Description: Measure fairness metrics in one place for many models. Check how big is model's bias towards different races, sex, nationalities etc. Use measures such as Statistical Parity, Equal odds to detect the discrimination against unprivileged groups. Visualize the bias using heatmap, radar plot, biplot, bar chart (and more!). There are various preprocessing and post-processing bias mitigation algorithms implemented.   
+Description: Measure fairness metrics in one place for many models. Check how big is model's bias towards different races, sex, nationalities etc. Use measures such as Statistical Parity, Equal odds to detect the discrimination against unprivileged groups. Visualize the bias using heatmap, radar plot, biplot, bar chart (and more!). There are various pre-processing and post-processing bias mitigation algorithms implemented.   
 License: GPL-3
 Encoding: UTF-8
 LazyData: true

NEWS.md

@@ -2,6 +2,7 @@
 * `fairness_check_data` now instead of `0` has `NA` due to concerns of interpretability - insignificant difference could lead up to maximal value of loss. With that change when `NA` is created user will see warning when plotting or printing. This doesn't affect other objects and plots.
 * Description fixes
 * Added `metric_scores` plot to basic tutorial
+* Updated new documentation in `roc_pivot`
 
 # fairmodels 0.2.1
 * bug related to `fairness check plot` fixed - rectangles did not appear for low epsilon values

R/roc_pivot.R

@@ -19,7 +19,8 @@
 #'
 #' @references Kamiran, Karim, Zhang 2012 \url{https://ieeexplore.ieee.org/document/6413831/} ROC method
 #'
-#' @return DALEX \code{explainer} with changed y_hat
+#' @return DALEX \code{explainer} with changed y_hat. This explainer should be used ONLY by fairmodels as it contains unchanged
+#' predict function (changed predictions (y_hat) can possibly be invisible by DALEX functions and methods).
 #' @export
 #'
 #' @examples