Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos of over_ratio and under_ratio #146

Merged
merged 3 commits into from
Dec 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion R/downsample.R
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion R/upsample.R
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
|---|---|---|
Expand Down Expand Up @@ -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 |
|---|---|---|---|
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
|-----------------------------------------------------------------|---------------------------|--------------------|
Expand Down Expand Up @@ -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 |
Expand Down
2 changes: 1 addition & 1 deletion man/adasyn.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/bsmote.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/nearmiss.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/smote.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/smotenc.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/step_adasyn.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/step_bsmote.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/step_downsample.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/step_nearmiss.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/step_rose.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/step_smote.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/step_smotenc.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/step_upsample.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.