Merge pull request #146 from jxu/typo-max

tidymodels · Dec 6, 2023 · 0f3709a · 0f3709a
2 parents c0a73eb + 4368efc
commit 0f3709a
Show file tree

Hide file tree

Showing 18 changed files with 21 additions and 19 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,7 @@
 # themis (development version)
 
+* Documentation now correctly specifies majority-to-minority and minority-to-majority. (#143, #110)
+
 # themis 1.0.2
 
 ## Improvements

diff --git a/R/downsample.R b/R/downsample.R
@@ -15,7 +15,7 @@
 #' @param column A character string of the variable name that will
 #'  be populated (eventually) by the `...` selectors.
 #' @param under_ratio A numeric value for the ratio of the
-#'  minority-to-majority frequencies. The default value (1) means
+#'  majority-to-minority frequencies. The default value (1) means
 #'  that all other levels are sampled down to have the same
 #'  frequency as the least occurring level. A value of 2 would mean
 #'  that the majority levels will have (at most) (approximately)

diff --git a/R/upsample.R b/R/upsample.R
@@ -15,7 +15,7 @@
 #' @param column A character string of the variable name that will
 #'  be populated (eventually) by the `...` selectors.
 #' @param over_ratio A numeric value for the ratio of the
-#'  majority-to-minority frequencies. The default value (1) means
+#'  minority-to-majority frequencies. The default value (1) means
 #'  that all other levels are sampled up to have the same
 #'  frequency as the most occurring level. A value of 0.5 would mean
 #'  that the minority levels will have (at most) (approximately)

diff --git a/README.Rmd b/README.Rmd
@@ -86,7 +86,7 @@ example_data %>%
 
 ### Upsample / Over-sampling
 
-The following methods all share the tuning parameter `over_ratio`, which is the ratio of the majority-to-minority frequencies.
+The following methods all share the tuning parameter `over_ratio`, which is the ratio of the minority-to-majority frequencies.
 
 | name | function | Multi-class |
 |---|---|---|
@@ -123,7 +123,7 @@ recipe(~., example_data) %>%
 
 ### Downsample / Under-sampling
 
-Most of the the following methods all share the tuning parameter `under_ratio`, which is the ratio of the minority-to-majority frequencies.
+Most of the the following methods all share the tuning parameter `under_ratio`, which is the ratio of the majority-to-minority frequencies.
 
 | name | function | Multi-class | under_ratio |
 |---|---|---|---|

diff --git a/README.md b/README.md
@@ -98,7 +98,7 @@ example_data %>%
 ### Upsample / Over-sampling
 
 The following methods all share the tuning parameter `over_ratio`, which
-is the ratio of the majority-to-minority frequencies.
+is the ratio of the minority-to-majority frequencies.
 
 | name                                                            | function                  | Multi-class        |
 |-----------------------------------------------------------------|---------------------------|--------------------|
@@ -140,7 +140,7 @@ recipe(~., example_data) %>%
 ### Downsample / Under-sampling
 
 Most of the the following methods all share the tuning parameter
-`under_ratio`, which is the ratio of the minority-to-majority
+`under_ratio`, which is the ratio of the majority-to-minority
 frequencies.
 
 | name                                            | function            | Multi-class        | under_ratio        |

diff --git a/man/adasyn.Rd b/man/adasyn.Rd
diff --git a/man/bsmote.Rd b/man/bsmote.Rd
diff --git a/man/nearmiss.Rd b/man/nearmiss.Rd
diff --git a/man/smote.Rd b/man/smote.Rd
diff --git a/man/smotenc.Rd b/man/smotenc.Rd
diff --git a/man/step_adasyn.Rd b/man/step_adasyn.Rd
diff --git a/man/step_bsmote.Rd b/man/step_bsmote.Rd
diff --git a/man/step_downsample.Rd b/man/step_downsample.Rd
diff --git a/man/step_nearmiss.Rd b/man/step_nearmiss.Rd
diff --git a/man/step_rose.Rd b/man/step_rose.Rd
diff --git a/man/step_smote.Rd b/man/step_smote.Rd
diff --git a/man/step_smotenc.Rd b/man/step_smotenc.Rd
diff --git a/man/step_upsample.Rd b/man/step_upsample.Rd