From a9781612a0663a9abff02066ba2905c57bc2dcc9 Mon Sep 17 00:00:00 2001 From: Hannah Frick Date: Wed, 21 Feb 2024 15:23:14 +0000 Subject: [PATCH 1/8] require v1.3.0 --- DESCRIPTION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index 14986a0d..24d15793 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -15,7 +15,7 @@ URL: https://dials.tidymodels.org, https://github.com/tidymodels/dials BugReports: https://github.com/tidymodels/dials/issues Depends: R (>= 3.4), - scales + scales (>= 1.3.0) Imports: cli, DiceDesign, From 1b5503899c966312ca53fa7952a50596e1e6de45 Mon Sep 17 00:00:00 2001 From: Hannah Frick Date: Wed, 21 Feb 2024 15:29:51 +0000 Subject: [PATCH 2/8] update to `transform_log2()` --- NAMESPACE | 2 +- R/dials-package.R | 2 +- R/param_network.R | 2 +- R/param_num_hash.R | 2 +- R/param_svm.R | 2 +- man/cost.Rd | 2 +- man/dropout.Rd | 2 +- man/texthash.Rd | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/NAMESPACE b/NAMESPACE index 7bd0ef38..dd8c120f 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -228,7 +228,7 @@ importFrom(purrr,map_int) importFrom(purrr,map_lgl) importFrom(scales,is.trans) importFrom(scales,log10_trans) -importFrom(scales,log2_trans) +importFrom(scales,transform_log2) importFrom(stats,runif) importFrom(tibble,as_tibble) importFrom(tibble,is_tibble) diff --git a/R/dials-package.R b/R/dials-package.R index 7a94a642..759b2511 100644 --- a/R/dials-package.R +++ b/R/dials-package.R @@ -39,7 +39,7 @@ #' @importFrom lifecycle deprecated #' @importFrom pillar type_sum #' @importFrom purrr map_lgl map2_dfc map_chr map map2 map_dfc map_dbl map_int -#' @importFrom scales log2_trans is.trans log10_trans +#' @importFrom scales transform_log2 is.trans log10_trans #' @importFrom stats runif #' @importFrom tibble as_tibble is_tibble tibble new_tibble #' @importFrom utils installed.packages globalVariables diff --git a/R/param_network.R b/R/param_network.R index 3f848b09..d6d030dd 100644 --- a/R/param_network.R +++ b/R/param_network.R @@ -53,7 +53,7 @@ hidden_units <- function(range = c(1L, 10L), trans = NULL) { #' @export #' @rdname dropout -batch_size <- function(range = c(unknown(), unknown()), trans = log2_trans()) { +batch_size <- function(range = c(unknown(), unknown()), trans = transform_log2()) { new_quant_param( type = "integer", range = range, diff --git a/R/param_num_hash.R b/R/param_num_hash.R index 96fc94c8..b3efe5c7 100644 --- a/R/param_num_hash.R +++ b/R/param_num_hash.R @@ -9,7 +9,7 @@ #' signed_hash() #' @export #' @rdname texthash -num_hash <- function(range = c(8L, 12L), trans = log2_trans()) { +num_hash <- function(range = c(8L, 12L), trans = transform_log2()) { new_quant_param( type = "integer", range = range, diff --git a/R/param_svm.R b/R/param_svm.R index d0288789..8123f5a3 100644 --- a/R/param_svm.R +++ b/R/param_svm.R @@ -7,7 +7,7 @@ #' cost() #' svm_margin() #' @export -cost <- function(range = c(-10, 5), trans = log2_trans()) { +cost <- function(range = c(-10, 5), trans = transform_log2()) { new_quant_param( type = "double", range = range, diff --git a/man/cost.Rd b/man/cost.Rd index 0ba2d6f8..c8ea4d25 100644 --- a/man/cost.Rd +++ b/man/cost.Rd @@ -5,7 +5,7 @@ \alias{svm_margin} \title{Support vector machine parameters} \usage{ -cost(range = c(-10, 5), trans = log2_trans()) +cost(range = c(-10, 5), trans = transform_log2()) svm_margin(range = c(0, 0.2), trans = NULL) } diff --git a/man/dropout.Rd b/man/dropout.Rd index 1814d5a3..1a2ec059 100644 --- a/man/dropout.Rd +++ b/man/dropout.Rd @@ -13,7 +13,7 @@ epochs(range = c(10L, 1000L), trans = NULL) hidden_units(range = c(1L, 10L), trans = NULL) -batch_size(range = c(unknown(), unknown()), trans = log2_trans()) +batch_size(range = c(unknown(), unknown()), trans = transform_log2()) } \arguments{ \item{range}{A two-element vector holding the \emph{defaults} for the smallest and diff --git a/man/texthash.Rd b/man/texthash.Rd index 7dbbfba7..bd2d09b2 100644 --- a/man/texthash.Rd +++ b/man/texthash.Rd @@ -5,7 +5,7 @@ \alias{signed_hash} \title{Text hashing parameters} \usage{ -num_hash(range = c(8L, 12L), trans = log2_trans()) +num_hash(range = c(8L, 12L), trans = transform_log2()) signed_hash(values = c(TRUE, FALSE)) } From b3c923f992bd0178dcbf46f4b81bf7438ae935ea Mon Sep 17 00:00:00 2001 From: Hannah Frick Date: Wed, 21 Feb 2024 15:36:46 +0000 Subject: [PATCH 3/8] update to `transform_log10()` --- NAMESPACE | 2 +- R/dials-package.R | 2 +- R/param_Laplace.R | 2 +- R/param_engine_c50.R | 2 +- R/param_engine_partykit.R | 2 +- R/param_engine_ranger.R | 2 +- R/param_engine_xgboost.R | 4 ++-- R/param_kernel.R | 4 ++-- R/param_learn_rate.R | 2 +- R/param_min_dist.R | 2 +- R/param_mtry.R | 2 +- R/param_penalty.R | 2 +- R/param_schedulers.R | 4 ++-- R/param_sparse_bayes_pca.R | 2 +- R/param_trees.R | 4 ++-- R/param_weight.R | 2 +- man/Laplace.Rd | 2 +- man/adjust_deg_free.Rd | 2 +- man/bart-param.Rd | 2 +- man/c5_parameters.Rd | 4 ++-- man/class_weights.Rd | 2 +- man/conditional_min_criterion.Rd | 2 +- man/cost.Rd | 2 +- man/cubist_parameters.Rd | 2 +- man/deg_free.Rd | 2 +- man/degree.Rd | 2 +- man/dist_power.Rd | 2 +- man/dropout.Rd | 2 +- man/earth_parameters.Rd | 2 +- man/freq_cut.Rd | 2 +- man/harmonic_frequency.Rd | 2 +- man/learn_rate.Rd | 4 ++-- man/lightgbm_parameters.Rd | 2 +- man/max_times.Rd | 2 +- man/max_tokens.Rd | 2 +- man/min_dist.Rd | 4 ++-- man/min_unique.Rd | 2 +- man/mixture.Rd | 2 +- man/momentum.Rd | 2 +- man/mtry.Rd | 4 ++-- man/mtry_prop.Rd | 2 +- man/neighbors.Rd | 2 +- man/num_breaks.Rd | 2 +- man/num_clusters.Rd | 2 +- man/num_comp.Rd | 2 +- man/num_knots.Rd | 2 +- man/num_runs.Rd | 2 +- man/num_tokens.Rd | 2 +- man/over_ratio.Rd | 2 +- man/penalty.Rd | 4 ++-- man/predictor_prop.Rd | 2 +- man/prior_slab_dispersion.Rd | 4 ++-- man/randomForest_parameters.Rd | 2 +- man/ranger_parameters.Rd | 4 ++-- man/rbf_sigma.Rd | 6 +++--- man/scheduler-param.Rd | 6 +++--- man/shrinkage_correlation.Rd | 2 +- man/smoothness.Rd | 2 +- man/stop_iter.Rd | 2 +- man/texthash.Rd | 2 +- man/threshold.Rd | 2 +- man/trees.Rd | 6 +++--- man/trim_amount.Rd | 2 +- man/validation_set_prop.Rd | 2 +- man/vocabulary_size.Rd | 2 +- man/weight.Rd | 4 ++-- man/window_size.Rd | 2 +- man/xgboost_parameters.Rd | 6 +++--- tests/testthat/test-finalize.R | 2 +- 69 files changed, 89 insertions(+), 89 deletions(-) diff --git a/NAMESPACE b/NAMESPACE index dd8c120f..829bd719 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -227,7 +227,7 @@ importFrom(purrr,map_dfc) importFrom(purrr,map_int) importFrom(purrr,map_lgl) importFrom(scales,is.trans) -importFrom(scales,log10_trans) +importFrom(scales,transform_log10) importFrom(scales,transform_log2) importFrom(stats,runif) importFrom(tibble,as_tibble) diff --git a/R/dials-package.R b/R/dials-package.R index 759b2511..01386646 100644 --- a/R/dials-package.R +++ b/R/dials-package.R @@ -39,7 +39,7 @@ #' @importFrom lifecycle deprecated #' @importFrom pillar type_sum #' @importFrom purrr map_lgl map2_dfc map_chr map map2 map_dfc map_dbl map_int -#' @importFrom scales transform_log2 is.trans log10_trans +#' @importFrom scales transform_log2 is.trans transform_log10 #' @importFrom stats runif #' @importFrom tibble as_tibble is_tibble tibble new_tibble #' @importFrom utils installed.packages globalVariables diff --git a/R/param_Laplace.R b/R/param_Laplace.R index 4ffe0fbb..e352b550 100644 --- a/R/param_Laplace.R +++ b/R/param_Laplace.R @@ -7,7 +7,7 @@ #' these values should be in the _transformed units_. #' #' @param trans A `trans` object from the `scales` package, such as -#' `scales::log10_trans()` or `scales::reciprocal_trans()`. If not provided, +#' `scales::transform_log10()` or `scales::reciprocal_trans()`. If not provided, #' the default is used which matches the units used in `range`. If no #' transformation, `NULL`. #' diff --git a/R/param_engine_c50.R b/R/param_engine_c50.R index 0f8b4d5a..89199576 100644 --- a/R/param_engine_c50.R +++ b/R/param_engine_c50.R @@ -17,7 +17,7 @@ #' rule_bands() #' @rdname c5_parameters #' @export -confidence_factor <- function(range = c(-1, 0), trans = log10_trans()) { +confidence_factor <- function(range = c(-1, 0), trans = transform_log10()) { new_quant_param( type = "double", range = range, diff --git a/R/param_engine_partykit.R b/R/param_engine_partykit.R index 45073b22..0e1f485b 100644 --- a/R/param_engine_partykit.R +++ b/R/param_engine_partykit.R @@ -4,7 +4,7 @@ #' largest possible values, respectively. #' #' @param trans A `trans` object from the `scales` package, such as -#' `scales::log10_trans()` or `scales::reciprocal_trans()`. If not provided, +#' `scales::transform_log10()` or `scales::reciprocal_trans()`. If not provided, #' the default is used which matches the units used in `range`. If no #' transformation, `NULL`. #' @param values A character string of possible values. diff --git a/R/param_engine_ranger.R b/R/param_engine_ranger.R index 243f28ef..f2d0bed0 100644 --- a/R/param_engine_ranger.R +++ b/R/param_engine_ranger.R @@ -43,7 +43,7 @@ regularize_depth <- function(values = c(TRUE, FALSE)) { #' @export #' @rdname ranger_parameters -significance_threshold <- function(range = c(-10, 0), trans = log10_trans()) { +significance_threshold <- function(range = c(-10, 0), trans = transform_log10()) { new_quant_param( type = "double", range = range, diff --git a/R/param_engine_xgboost.R b/R/param_engine_xgboost.R index 3232c67a..5c8edd5c 100644 --- a/R/param_engine_xgboost.R +++ b/R/param_engine_xgboost.R @@ -28,7 +28,7 @@ scale_pos_weight <- function(range = c(0.8, 1.2), trans = NULL) { #' @rdname xgboost_parameters #' @export -penalty_L2 <- function(range = c(-10, 1), trans = log10_trans()) { +penalty_L2 <- function(range = c(-10, 1), trans = transform_log10()) { new_quant_param( type = "double", range = range, @@ -41,7 +41,7 @@ penalty_L2 <- function(range = c(-10, 1), trans = log10_trans()) { #' @rdname xgboost_parameters #' @export -penalty_L1 <- function(range = c(-10, 1), trans = log10_trans()) { +penalty_L1 <- function(range = c(-10, 1), trans = transform_log10()) { new_quant_param( type = "double", range = range, diff --git a/R/param_kernel.R b/R/param_kernel.R index fd9da403..bfcd23ef 100644 --- a/R/param_kernel.R +++ b/R/param_kernel.R @@ -10,7 +10,7 @@ #' scale_factor() #' kernel_offset() #' @export -rbf_sigma <- function(range = c(-10, 0), trans = log10_trans()) { +rbf_sigma <- function(range = c(-10, 0), trans = transform_log10()) { new_quant_param( type = "double", range = range, @@ -23,7 +23,7 @@ rbf_sigma <- function(range = c(-10, 0), trans = log10_trans()) { #' @rdname rbf_sigma #' @export -scale_factor <- function(range = c(-10, -1), trans = log10_trans()) { +scale_factor <- function(range = c(-10, -1), trans = transform_log10()) { new_quant_param( type = "double", range = range, diff --git a/R/param_learn_rate.R b/R/param_learn_rate.R index 0055d5ad..1ab60ead 100644 --- a/R/param_learn_rate.R +++ b/R/param_learn_rate.R @@ -12,7 +12,7 @@ #' @examples #' learn_rate() #' @export -learn_rate <- function(range = c(-10, -1), trans = log10_trans()) { +learn_rate <- function(range = c(-10, -1), trans = transform_log10()) { new_quant_param( type = "double", range = range, diff --git a/R/param_min_dist.R b/R/param_min_dist.R index 9205097d..5ce7a45f 100644 --- a/R/param_min_dist.R +++ b/R/param_min_dist.R @@ -6,7 +6,7 @@ #' @examples #' min_dist() #' @export -min_dist <- function(range = c(-4, 0), trans = log10_trans()) { +min_dist <- function(range = c(-4, 0), trans = transform_log10()) { new_quant_param( type = "double", range = range, diff --git a/R/param_mtry.R b/R/param_mtry.R index 16b5e1d8..0a826312 100644 --- a/R/param_mtry.R +++ b/R/param_mtry.R @@ -31,7 +31,7 @@ mtry <- function(range = c(1L, unknown()), trans = NULL) { #' @export #' @rdname mtry -mtry_long <- function(range = c(0L, unknown()), trans = log10_trans()) { +mtry_long <- function(range = c(0L, unknown()), trans = transform_log10()) { new_quant_param( type = "integer", range = range, diff --git a/R/param_penalty.R b/R/param_penalty.R index dc025142..7ca78c06 100644 --- a/R/param_penalty.R +++ b/R/param_penalty.R @@ -11,7 +11,7 @@ #' @examples #' penalty() #' @export -penalty <- function(range = c(-10, 0), trans = log10_trans()) { +penalty <- function(range = c(-10, 0), trans = transform_log10()) { new_quant_param( type = "double", range = range, diff --git a/R/param_schedulers.R b/R/param_schedulers.R index b82bac6f..e2a2daeb 100644 --- a/R/param_schedulers.R +++ b/R/param_schedulers.R @@ -20,7 +20,7 @@ #' #' @name scheduler-param #' @export -rate_initial <- function (range = c(-3,-1), trans = log10_trans()) { +rate_initial <- function (range = c(-3,-1), trans = transform_log10()) { new_quant_param( type = "double", range = range, @@ -33,7 +33,7 @@ rate_initial <- function (range = c(-3,-1), trans = log10_trans()) { #' @rdname scheduler-param #' @export -rate_largest <- function (range = c(-1, -1 / 2), trans = log10_trans()) { +rate_largest <- function (range = c(-1, -1 / 2), trans = transform_log10()) { new_quant_param( type = "double", range = range, diff --git a/R/param_sparse_bayes_pca.R b/R/param_sparse_bayes_pca.R index 8991724e..b163b055 100644 --- a/R/param_sparse_bayes_pca.R +++ b/R/param_sparse_bayes_pca.R @@ -16,7 +16,7 @@ #' @examples #' mixture() #' @export -prior_slab_dispersion <- function(range = c(-1/2, log10(3)), trans = log10_trans()) { +prior_slab_dispersion <- function(range = c(-1/2, log10(3)), trans = transform_log10()) { new_quant_param( type = "double", range = range, diff --git a/R/param_trees.R b/R/param_trees.R index 1755f463..896fb9cb 100644 --- a/R/param_trees.R +++ b/R/param_trees.R @@ -96,7 +96,7 @@ sample_prop <- function(range = c(1/10, 1), trans = NULL) { #' @rdname trees #' @export -loss_reduction <- function(range = c(-10, 1.5), trans = log10_trans()) { +loss_reduction <- function(range = c(-10, 1.5), trans = transform_log10()) { new_quant_param( type = "double", range = range, @@ -133,7 +133,7 @@ prune <- function(values = c(TRUE, FALSE)) { #' @export #' @rdname trees -cost_complexity <- function(range = c(-10, -1), trans = log10_trans()) { +cost_complexity <- function(range = c(-10, -1), trans = transform_log10()) { new_quant_param( type = "double", range = range, diff --git a/R/param_weight.R b/R/param_weight.R index 85add9ee..6d1c76bb 100644 --- a/R/param_weight.R +++ b/R/param_weight.R @@ -6,7 +6,7 @@ #' @examples #' weight() #' @export -weight <- function(range = c(-10, 0), trans = log10_trans()) { +weight <- function(range = c(-10, 0), trans = transform_log10()) { new_quant_param( type = "double", range = range, diff --git a/man/Laplace.Rd b/man/Laplace.Rd index b5073113..d64e6639 100644 --- a/man/Laplace.Rd +++ b/man/Laplace.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/adjust_deg_free.Rd b/man/adjust_deg_free.Rd index aeb8877b..d9ddcd30 100644 --- a/man/adjust_deg_free.Rd +++ b/man/adjust_deg_free.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/bart-param.Rd b/man/bart-param.Rd index e4abcf47..c90ca0ed 100644 --- a/man/bart-param.Rd +++ b/man/bart-param.Rd @@ -21,7 +21,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/c5_parameters.Rd b/man/c5_parameters.Rd index 4339409b..26fac9e6 100644 --- a/man/c5_parameters.Rd +++ b/man/c5_parameters.Rd @@ -8,7 +8,7 @@ \alias{rule_bands} \title{Parameters for possible engine parameters for C5.0} \usage{ -confidence_factor(range = c(-1, 0), trans = log10_trans()) +confidence_factor(range = c(-1, 0), trans = transform_log10()) no_global_pruning(values = c(TRUE, FALSE)) @@ -24,7 +24,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} diff --git a/man/class_weights.Rd b/man/class_weights.Rd index 4ff2a5bd..2041ee6f 100644 --- a/man/class_weights.Rd +++ b/man/class_weights.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/conditional_min_criterion.Rd b/man/conditional_min_criterion.Rd index 6679f8eb..6fefa8ed 100644 --- a/man/conditional_min_criterion.Rd +++ b/man/conditional_min_criterion.Rd @@ -32,7 +32,7 @@ conditional_test_statistic(values = values_test_statistic) largest possible values, respectively.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} diff --git a/man/cost.Rd b/man/cost.Rd index c8ea4d25..b3fcbd1a 100644 --- a/man/cost.Rd +++ b/man/cost.Rd @@ -15,7 +15,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/cubist_parameters.Rd b/man/cubist_parameters.Rd index 58a70c04..96fde2ff 100644 --- a/man/cubist_parameters.Rd +++ b/man/cubist_parameters.Rd @@ -18,7 +18,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} diff --git a/man/deg_free.Rd b/man/deg_free.Rd index 9d835a5b..be36b5d3 100644 --- a/man/deg_free.Rd +++ b/man/deg_free.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/degree.Rd b/man/degree.Rd index c40e55ba..2aabca99 100644 --- a/man/degree.Rd +++ b/man/degree.Rd @@ -21,7 +21,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/dist_power.Rd b/man/dist_power.Rd index aad9ed4f..5de9b7c9 100644 --- a/man/dist_power.Rd +++ b/man/dist_power.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/dropout.Rd b/man/dropout.Rd index 1a2ec059..fca01dbd 100644 --- a/man/dropout.Rd +++ b/man/dropout.Rd @@ -21,7 +21,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/earth_parameters.Rd b/man/earth_parameters.Rd index 2d569e9e..62bc2bcf 100644 --- a/man/earth_parameters.Rd +++ b/man/earth_parameters.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/freq_cut.Rd b/man/freq_cut.Rd index a66175cb..f3d89966 100644 --- a/man/freq_cut.Rd +++ b/man/freq_cut.Rd @@ -15,7 +15,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/harmonic_frequency.Rd b/man/harmonic_frequency.Rd index 78370792..b398c851 100644 --- a/man/harmonic_frequency.Rd +++ b/man/harmonic_frequency.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/learn_rate.Rd b/man/learn_rate.Rd index 37d09b25..5ff4508a 100644 --- a/man/learn_rate.Rd +++ b/man/learn_rate.Rd @@ -4,7 +4,7 @@ \alias{learn_rate} \title{Learning rate} \usage{ -learn_rate(range = c(-10, -1), trans = log10_trans()) +learn_rate(range = c(-10, -1), trans = transform_log10()) } \arguments{ \item{range}{A two-element vector holding the \emph{defaults} for the smallest and @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/lightgbm_parameters.Rd b/man/lightgbm_parameters.Rd index a0267ba4..a987898f 100644 --- a/man/lightgbm_parameters.Rd +++ b/man/lightgbm_parameters.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/max_times.Rd b/man/max_times.Rd index 5f51671f..7226f67b 100644 --- a/man/max_times.Rd +++ b/man/max_times.Rd @@ -15,7 +15,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/max_tokens.Rd b/man/max_tokens.Rd index 2abbca97..d7224c39 100644 --- a/man/max_tokens.Rd +++ b/man/max_tokens.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/min_dist.Rd b/man/min_dist.Rd index ef9a3a5a..711a7172 100644 --- a/man/min_dist.Rd +++ b/man/min_dist.Rd @@ -4,7 +4,7 @@ \alias{min_dist} \title{Parameter for the effective minimum distance between embedded points} \usage{ -min_dist(range = c(-4, 0), trans = log10_trans()) +min_dist(range = c(-4, 0), trans = transform_log10()) } \arguments{ \item{range}{A two-element vector holding the \emph{defaults} for the smallest and @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/min_unique.Rd b/man/min_unique.Rd index 62ce1208..a24f33ee 100644 --- a/man/min_unique.Rd +++ b/man/min_unique.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/mixture.Rd b/man/mixture.Rd index a679c0fd..451393d6 100644 --- a/man/mixture.Rd +++ b/man/mixture.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/momentum.Rd b/man/momentum.Rd index 56a56680..62014709 100644 --- a/man/momentum.Rd +++ b/man/momentum.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/mtry.Rd b/man/mtry.Rd index b5b10b61..100cd2a8 100644 --- a/man/mtry.Rd +++ b/man/mtry.Rd @@ -7,7 +7,7 @@ \usage{ mtry(range = c(1L, unknown()), trans = NULL) -mtry_long(range = c(0L, unknown()), trans = log10_trans()) +mtry_long(range = c(0L, unknown()), trans = transform_log10()) } \arguments{ \item{range}{A two-element vector holding the \emph{defaults} for the smallest and @@ -15,7 +15,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/mtry_prop.Rd b/man/mtry_prop.Rd index 880eef0f..63a53e0d 100644 --- a/man/mtry_prop.Rd +++ b/man/mtry_prop.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/neighbors.Rd b/man/neighbors.Rd index ee45135e..a94c4bd8 100644 --- a/man/neighbors.Rd +++ b/man/neighbors.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/num_breaks.Rd b/man/num_breaks.Rd index 60c593be..83679785 100644 --- a/man/num_breaks.Rd +++ b/man/num_breaks.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/num_clusters.Rd b/man/num_clusters.Rd index 484deb5c..3269e26e 100644 --- a/man/num_clusters.Rd +++ b/man/num_clusters.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/num_comp.Rd b/man/num_comp.Rd index 1355e1a1..026ecdcb 100644 --- a/man/num_comp.Rd +++ b/man/num_comp.Rd @@ -15,7 +15,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/num_knots.Rd b/man/num_knots.Rd index 2c60d587..5bff2fc4 100644 --- a/man/num_knots.Rd +++ b/man/num_knots.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/num_runs.Rd b/man/num_runs.Rd index f7a4a206..745f5c62 100644 --- a/man/num_runs.Rd +++ b/man/num_runs.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/num_tokens.Rd b/man/num_tokens.Rd index 378f8304..25932f5e 100644 --- a/man/num_tokens.Rd +++ b/man/num_tokens.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/over_ratio.Rd b/man/over_ratio.Rd index ede6e30b..7bb1d38c 100644 --- a/man/over_ratio.Rd +++ b/man/over_ratio.Rd @@ -15,7 +15,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/penalty.Rd b/man/penalty.Rd index 6f9c607c..c43cdad6 100644 --- a/man/penalty.Rd +++ b/man/penalty.Rd @@ -4,7 +4,7 @@ \alias{penalty} \title{Amount of regularization/penalization} \usage{ -penalty(range = c(-10, 0), trans = log10_trans()) +penalty(range = c(-10, 0), trans = transform_log10()) } \arguments{ \item{range}{A two-element vector holding the \emph{defaults} for the smallest and @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/predictor_prop.Rd b/man/predictor_prop.Rd index 5077b431..9419cfd9 100644 --- a/man/predictor_prop.Rd +++ b/man/predictor_prop.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/prior_slab_dispersion.Rd b/man/prior_slab_dispersion.Rd index 43397a74..d0287a81 100644 --- a/man/prior_slab_dispersion.Rd +++ b/man/prior_slab_dispersion.Rd @@ -5,7 +5,7 @@ \alias{prior_mixture_threshold} \title{Bayesian PCA parameters} \usage{ -prior_slab_dispersion(range = c(-1/2, log10(3)), trans = log10_trans()) +prior_slab_dispersion(range = c(-1/2, log10(3)), trans = transform_log10()) prior_mixture_threshold(range = c(0, 1), trans = NULL) } @@ -15,7 +15,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/randomForest_parameters.Rd b/man/randomForest_parameters.Rd index 15cb6229..de278ba8 100644 --- a/man/randomForest_parameters.Rd +++ b/man/randomForest_parameters.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/ranger_parameters.Rd b/man/ranger_parameters.Rd index 8a9dcff9..455dc94e 100644 --- a/man/ranger_parameters.Rd +++ b/man/ranger_parameters.Rd @@ -24,7 +24,7 @@ regularization_factor(range = c(0, 1), trans = NULL) regularize_depth(values = c(TRUE, FALSE)) -significance_threshold(range = c(-10, 0), trans = log10_trans()) +significance_threshold(range = c(-10, 0), trans = transform_log10()) lower_quantile(range = c(0, 1), trans = NULL) @@ -44,7 +44,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} diff --git a/man/rbf_sigma.Rd b/man/rbf_sigma.Rd index 4cac107d..bc4e23db 100644 --- a/man/rbf_sigma.Rd +++ b/man/rbf_sigma.Rd @@ -6,9 +6,9 @@ \alias{kernel_offset} \title{Kernel parameters} \usage{ -rbf_sigma(range = c(-10, 0), trans = log10_trans()) +rbf_sigma(range = c(-10, 0), trans = transform_log10()) -scale_factor(range = c(-10, -1), trans = log10_trans()) +scale_factor(range = c(-10, -1), trans = transform_log10()) kernel_offset(range = c(0, 2), trans = NULL) } @@ -18,7 +18,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/scheduler-param.Rd b/man/scheduler-param.Rd index 3ed6d845..4c762b3e 100644 --- a/man/scheduler-param.Rd +++ b/man/scheduler-param.Rd @@ -17,9 +17,9 @@ These parameters are used for constructing neural network models.} An object of class \code{character} of length 5. } \usage{ -rate_initial(range = c(-3, -1), trans = log10_trans()) +rate_initial(range = c(-3, -1), trans = transform_log10()) -rate_largest(range = c(-1, -1/2), trans = log10_trans()) +rate_largest(range = c(-1, -1/2), trans = transform_log10()) rate_reduction(range = c(1/5, 1), trans = NULL) @@ -39,7 +39,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} diff --git a/man/shrinkage_correlation.Rd b/man/shrinkage_correlation.Rd index c332f36c..9d1415e8 100644 --- a/man/shrinkage_correlation.Rd +++ b/man/shrinkage_correlation.Rd @@ -21,7 +21,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} diff --git a/man/smoothness.Rd b/man/smoothness.Rd index 57d8a6d5..be0aa715 100644 --- a/man/smoothness.Rd +++ b/man/smoothness.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/stop_iter.Rd b/man/stop_iter.Rd index 9c84e00f..67357d73 100644 --- a/man/stop_iter.Rd +++ b/man/stop_iter.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/texthash.Rd b/man/texthash.Rd index bd2d09b2..99831396 100644 --- a/man/texthash.Rd +++ b/man/texthash.Rd @@ -15,7 +15,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} diff --git a/man/threshold.Rd b/man/threshold.Rd index 2bbb01c7..33b77814 100644 --- a/man/threshold.Rd +++ b/man/threshold.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/trees.Rd b/man/trees.Rd index e32f2642..587f3d44 100644 --- a/man/trees.Rd +++ b/man/trees.Rd @@ -19,13 +19,13 @@ sample_size(range = c(unknown(), unknown()), trans = NULL) sample_prop(range = c(1/10, 1), trans = NULL) -loss_reduction(range = c(-10, 1.5), trans = log10_trans()) +loss_reduction(range = c(-10, 1.5), trans = transform_log10()) tree_depth(range = c(1L, 15L), trans = NULL) prune(values = c(TRUE, FALSE)) -cost_complexity(range = c(-10, -1), trans = log10_trans()) +cost_complexity(range = c(-10, -1), trans = transform_log10()) } \arguments{ \item{range}{A two-element vector holding the \emph{defaults} for the smallest and @@ -33,7 +33,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} diff --git a/man/trim_amount.Rd b/man/trim_amount.Rd index 77a7411b..bfe0138b 100644 --- a/man/trim_amount.Rd +++ b/man/trim_amount.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/validation_set_prop.Rd b/man/validation_set_prop.Rd index cea9d6bd..b1c88a31 100644 --- a/man/validation_set_prop.Rd +++ b/man/validation_set_prop.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/vocabulary_size.Rd b/man/vocabulary_size.Rd index daef4cb5..20320b3d 100644 --- a/man/vocabulary_size.Rd +++ b/man/vocabulary_size.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/weight.Rd b/man/weight.Rd index c868f161..1099a9e2 100644 --- a/man/weight.Rd +++ b/man/weight.Rd @@ -4,7 +4,7 @@ \alias{weight} \title{Parameter for \code{"double normalization"} when creating token counts} \usage{ -weight(range = c(-10, 0), trans = log10_trans()) +weight(range = c(-10, 0), trans = transform_log10()) } \arguments{ \item{range}{A two-element vector holding the \emph{defaults} for the smallest and @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/window_size.Rd b/man/window_size.Rd index 22aeb160..7971cf8f 100644 --- a/man/window_size.Rd +++ b/man/window_size.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/xgboost_parameters.Rd b/man/xgboost_parameters.Rd index eb5fcf7c..1b8d6bcc 100644 --- a/man/xgboost_parameters.Rd +++ b/man/xgboost_parameters.Rd @@ -8,9 +8,9 @@ \usage{ scale_pos_weight(range = c(0.8, 1.2), trans = NULL) -penalty_L2(range = c(-10, 1), trans = log10_trans()) +penalty_L2(range = c(-10, 1), trans = transform_log10()) -penalty_L1(range = c(-10, 1), trans = log10_trans()) +penalty_L1(range = c(-10, 1), trans = transform_log10()) } \arguments{ \item{range}{A two-element vector holding the \emph{defaults} for the smallest and @@ -18,7 +18,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::log10_trans()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/tests/testthat/test-finalize.R b/tests/testthat/test-finalize.R index 0dafeed5..2464eb43 100644 --- a/tests/testthat/test-finalize.R +++ b/tests/testthat/test-finalize.R @@ -32,7 +32,7 @@ test_that("estimate rows", { ) expect_equal( get_n_frac_range( - sample_size(c(unknown(), unknown()), trans = log10_trans()), + sample_size(c(unknown(), unknown()), trans = transform_log10()), x = warpbreaks, log_vals = TRUE, frac = c(.3, .7) From ae43175fc0f3f178cda7d39a496d5657133305a3 Mon Sep 17 00:00:00 2001 From: Hannah Frick Date: Wed, 21 Feb 2024 15:39:03 +0000 Subject: [PATCH 4/8] update to `transform_reciprocal()` --- R/param_Laplace.R | 2 +- R/param_engine_partykit.R | 2 +- man/Laplace.Rd | 2 +- man/adjust_deg_free.Rd | 2 +- man/bart-param.Rd | 2 +- man/c5_parameters.Rd | 2 +- man/class_weights.Rd | 2 +- man/conditional_min_criterion.Rd | 2 +- man/cost.Rd | 2 +- man/cubist_parameters.Rd | 2 +- man/deg_free.Rd | 2 +- man/degree.Rd | 2 +- man/dist_power.Rd | 2 +- man/dropout.Rd | 2 +- man/earth_parameters.Rd | 2 +- man/freq_cut.Rd | 2 +- man/harmonic_frequency.Rd | 2 +- man/learn_rate.Rd | 2 +- man/lightgbm_parameters.Rd | 2 +- man/max_times.Rd | 2 +- man/max_tokens.Rd | 2 +- man/min_dist.Rd | 2 +- man/min_unique.Rd | 2 +- man/mixture.Rd | 2 +- man/momentum.Rd | 2 +- man/mtry.Rd | 2 +- man/mtry_prop.Rd | 2 +- man/neighbors.Rd | 2 +- man/num_breaks.Rd | 2 +- man/num_clusters.Rd | 2 +- man/num_comp.Rd | 2 +- man/num_knots.Rd | 2 +- man/num_runs.Rd | 2 +- man/num_tokens.Rd | 2 +- man/over_ratio.Rd | 2 +- man/penalty.Rd | 2 +- man/predictor_prop.Rd | 2 +- man/prior_slab_dispersion.Rd | 2 +- man/randomForest_parameters.Rd | 2 +- man/ranger_parameters.Rd | 2 +- man/rbf_sigma.Rd | 2 +- man/scheduler-param.Rd | 2 +- man/shrinkage_correlation.Rd | 2 +- man/smoothness.Rd | 2 +- man/stop_iter.Rd | 2 +- man/texthash.Rd | 2 +- man/threshold.Rd | 2 +- man/trees.Rd | 2 +- man/trim_amount.Rd | 2 +- man/validation_set_prop.Rd | 2 +- man/vocabulary_size.Rd | 2 +- man/weight.Rd | 2 +- man/window_size.Rd | 2 +- man/xgboost_parameters.Rd | 2 +- 54 files changed, 54 insertions(+), 54 deletions(-) diff --git a/R/param_Laplace.R b/R/param_Laplace.R index e352b550..33e1ccee 100644 --- a/R/param_Laplace.R +++ b/R/param_Laplace.R @@ -7,7 +7,7 @@ #' these values should be in the _transformed units_. #' #' @param trans A `trans` object from the `scales` package, such as -#' `scales::transform_log10()` or `scales::reciprocal_trans()`. If not provided, +#' `scales::transform_log10()` or `scales::transform_reciprocal()`. If not provided, #' the default is used which matches the units used in `range`. If no #' transformation, `NULL`. #' diff --git a/R/param_engine_partykit.R b/R/param_engine_partykit.R index 0e1f485b..a8001ad6 100644 --- a/R/param_engine_partykit.R +++ b/R/param_engine_partykit.R @@ -4,7 +4,7 @@ #' largest possible values, respectively. #' #' @param trans A `trans` object from the `scales` package, such as -#' `scales::transform_log10()` or `scales::reciprocal_trans()`. If not provided, +#' `scales::transform_log10()` or `scales::transform_reciprocal()`. If not provided, #' the default is used which matches the units used in `range`. If no #' transformation, `NULL`. #' @param values A character string of possible values. diff --git a/man/Laplace.Rd b/man/Laplace.Rd index d64e6639..ec174808 100644 --- a/man/Laplace.Rd +++ b/man/Laplace.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/adjust_deg_free.Rd b/man/adjust_deg_free.Rd index d9ddcd30..c7f3cbc8 100644 --- a/man/adjust_deg_free.Rd +++ b/man/adjust_deg_free.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/bart-param.Rd b/man/bart-param.Rd index c90ca0ed..efefd495 100644 --- a/man/bart-param.Rd +++ b/man/bart-param.Rd @@ -21,7 +21,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/c5_parameters.Rd b/man/c5_parameters.Rd index 26fac9e6..ed29d328 100644 --- a/man/c5_parameters.Rd +++ b/man/c5_parameters.Rd @@ -24,7 +24,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} diff --git a/man/class_weights.Rd b/man/class_weights.Rd index 2041ee6f..cb3dc112 100644 --- a/man/class_weights.Rd +++ b/man/class_weights.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/conditional_min_criterion.Rd b/man/conditional_min_criterion.Rd index 6fefa8ed..136b8901 100644 --- a/man/conditional_min_criterion.Rd +++ b/man/conditional_min_criterion.Rd @@ -32,7 +32,7 @@ conditional_test_statistic(values = values_test_statistic) largest possible values, respectively.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} diff --git a/man/cost.Rd b/man/cost.Rd index b3fcbd1a..4e018ed4 100644 --- a/man/cost.Rd +++ b/man/cost.Rd @@ -15,7 +15,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/cubist_parameters.Rd b/man/cubist_parameters.Rd index 96fde2ff..78bafbfa 100644 --- a/man/cubist_parameters.Rd +++ b/man/cubist_parameters.Rd @@ -18,7 +18,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} diff --git a/man/deg_free.Rd b/man/deg_free.Rd index be36b5d3..b0bb1512 100644 --- a/man/deg_free.Rd +++ b/man/deg_free.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/degree.Rd b/man/degree.Rd index 2aabca99..52dc7138 100644 --- a/man/degree.Rd +++ b/man/degree.Rd @@ -21,7 +21,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/dist_power.Rd b/man/dist_power.Rd index 5de9b7c9..65e59096 100644 --- a/man/dist_power.Rd +++ b/man/dist_power.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/dropout.Rd b/man/dropout.Rd index fca01dbd..507f7791 100644 --- a/man/dropout.Rd +++ b/man/dropout.Rd @@ -21,7 +21,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/earth_parameters.Rd b/man/earth_parameters.Rd index 62bc2bcf..c89e91f2 100644 --- a/man/earth_parameters.Rd +++ b/man/earth_parameters.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/freq_cut.Rd b/man/freq_cut.Rd index f3d89966..5a823320 100644 --- a/man/freq_cut.Rd +++ b/man/freq_cut.Rd @@ -15,7 +15,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/harmonic_frequency.Rd b/man/harmonic_frequency.Rd index b398c851..d606cfd0 100644 --- a/man/harmonic_frequency.Rd +++ b/man/harmonic_frequency.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/learn_rate.Rd b/man/learn_rate.Rd index 5ff4508a..02353874 100644 --- a/man/learn_rate.Rd +++ b/man/learn_rate.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/lightgbm_parameters.Rd b/man/lightgbm_parameters.Rd index a987898f..1bca728b 100644 --- a/man/lightgbm_parameters.Rd +++ b/man/lightgbm_parameters.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/max_times.Rd b/man/max_times.Rd index 7226f67b..3f667dc5 100644 --- a/man/max_times.Rd +++ b/man/max_times.Rd @@ -15,7 +15,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/max_tokens.Rd b/man/max_tokens.Rd index d7224c39..397d3281 100644 --- a/man/max_tokens.Rd +++ b/man/max_tokens.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/min_dist.Rd b/man/min_dist.Rd index 711a7172..0c791b58 100644 --- a/man/min_dist.Rd +++ b/man/min_dist.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/min_unique.Rd b/man/min_unique.Rd index a24f33ee..a64a58c8 100644 --- a/man/min_unique.Rd +++ b/man/min_unique.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/mixture.Rd b/man/mixture.Rd index 451393d6..ec4d0ecd 100644 --- a/man/mixture.Rd +++ b/man/mixture.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/momentum.Rd b/man/momentum.Rd index 62014709..2b3e44f0 100644 --- a/man/momentum.Rd +++ b/man/momentum.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/mtry.Rd b/man/mtry.Rd index 100cd2a8..fb41e9fe 100644 --- a/man/mtry.Rd +++ b/man/mtry.Rd @@ -15,7 +15,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/mtry_prop.Rd b/man/mtry_prop.Rd index 63a53e0d..83c5bae2 100644 --- a/man/mtry_prop.Rd +++ b/man/mtry_prop.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/neighbors.Rd b/man/neighbors.Rd index a94c4bd8..cfbcfc1a 100644 --- a/man/neighbors.Rd +++ b/man/neighbors.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/num_breaks.Rd b/man/num_breaks.Rd index 83679785..86323294 100644 --- a/man/num_breaks.Rd +++ b/man/num_breaks.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/num_clusters.Rd b/man/num_clusters.Rd index 3269e26e..3ec43e8e 100644 --- a/man/num_clusters.Rd +++ b/man/num_clusters.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/num_comp.Rd b/man/num_comp.Rd index 026ecdcb..2281319a 100644 --- a/man/num_comp.Rd +++ b/man/num_comp.Rd @@ -15,7 +15,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/num_knots.Rd b/man/num_knots.Rd index 5bff2fc4..a8d46829 100644 --- a/man/num_knots.Rd +++ b/man/num_knots.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/num_runs.Rd b/man/num_runs.Rd index 745f5c62..e3a53278 100644 --- a/man/num_runs.Rd +++ b/man/num_runs.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/num_tokens.Rd b/man/num_tokens.Rd index 25932f5e..d5249876 100644 --- a/man/num_tokens.Rd +++ b/man/num_tokens.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/over_ratio.Rd b/man/over_ratio.Rd index 7bb1d38c..2b8dbec2 100644 --- a/man/over_ratio.Rd +++ b/man/over_ratio.Rd @@ -15,7 +15,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/penalty.Rd b/man/penalty.Rd index c43cdad6..bab7c704 100644 --- a/man/penalty.Rd +++ b/man/penalty.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/predictor_prop.Rd b/man/predictor_prop.Rd index 9419cfd9..2f2ed09f 100644 --- a/man/predictor_prop.Rd +++ b/man/predictor_prop.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/prior_slab_dispersion.Rd b/man/prior_slab_dispersion.Rd index d0287a81..533a89fa 100644 --- a/man/prior_slab_dispersion.Rd +++ b/man/prior_slab_dispersion.Rd @@ -15,7 +15,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/randomForest_parameters.Rd b/man/randomForest_parameters.Rd index de278ba8..8df1d49e 100644 --- a/man/randomForest_parameters.Rd +++ b/man/randomForest_parameters.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/ranger_parameters.Rd b/man/ranger_parameters.Rd index 455dc94e..020ba805 100644 --- a/man/ranger_parameters.Rd +++ b/man/ranger_parameters.Rd @@ -44,7 +44,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} diff --git a/man/rbf_sigma.Rd b/man/rbf_sigma.Rd index bc4e23db..ebceb6b3 100644 --- a/man/rbf_sigma.Rd +++ b/man/rbf_sigma.Rd @@ -18,7 +18,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/scheduler-param.Rd b/man/scheduler-param.Rd index 4c762b3e..0410054c 100644 --- a/man/scheduler-param.Rd +++ b/man/scheduler-param.Rd @@ -39,7 +39,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} diff --git a/man/shrinkage_correlation.Rd b/man/shrinkage_correlation.Rd index 9d1415e8..e788ae98 100644 --- a/man/shrinkage_correlation.Rd +++ b/man/shrinkage_correlation.Rd @@ -21,7 +21,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} diff --git a/man/smoothness.Rd b/man/smoothness.Rd index be0aa715..4debd109 100644 --- a/man/smoothness.Rd +++ b/man/smoothness.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/stop_iter.Rd b/man/stop_iter.Rd index 67357d73..b592ec45 100644 --- a/man/stop_iter.Rd +++ b/man/stop_iter.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/texthash.Rd b/man/texthash.Rd index 99831396..bdd3f639 100644 --- a/man/texthash.Rd +++ b/man/texthash.Rd @@ -15,7 +15,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} diff --git a/man/threshold.Rd b/man/threshold.Rd index 33b77814..8c84de2b 100644 --- a/man/threshold.Rd +++ b/man/threshold.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/trees.Rd b/man/trees.Rd index 587f3d44..2bcc2a97 100644 --- a/man/trees.Rd +++ b/man/trees.Rd @@ -33,7 +33,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} diff --git a/man/trim_amount.Rd b/man/trim_amount.Rd index bfe0138b..61d034fe 100644 --- a/man/trim_amount.Rd +++ b/man/trim_amount.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/validation_set_prop.Rd b/man/validation_set_prop.Rd index b1c88a31..808a5a49 100644 --- a/man/validation_set_prop.Rd +++ b/man/validation_set_prop.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/vocabulary_size.Rd b/man/vocabulary_size.Rd index 20320b3d..335aea15 100644 --- a/man/vocabulary_size.Rd +++ b/man/vocabulary_size.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/weight.Rd b/man/weight.Rd index 1099a9e2..7afebc6b 100644 --- a/man/weight.Rd +++ b/man/weight.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/window_size.Rd b/man/window_size.Rd index 7971cf8f..032f3394 100644 --- a/man/window_size.Rd +++ b/man/window_size.Rd @@ -12,7 +12,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } diff --git a/man/xgboost_parameters.Rd b/man/xgboost_parameters.Rd index 1b8d6bcc..8a1a791e 100644 --- a/man/xgboost_parameters.Rd +++ b/man/xgboost_parameters.Rd @@ -18,7 +18,7 @@ largest possible values, respectively. If a transformation is specified, these values should be in the \emph{transformed units}.} \item{trans}{A \code{trans} object from the \code{scales} package, such as -\code{scales::transform_log10()} or \code{scales::reciprocal_trans()}. If not provided, +\code{scales::transform_log10()} or \code{scales::transform_reciprocal()}. If not provided, the default is used which matches the units used in \code{range}. If no transformation, \code{NULL}.} } From 2b8aad2d8073e574fe50c08d6522653b39fdee22 Mon Sep 17 00:00:00 2001 From: Hannah Frick Date: Wed, 21 Feb 2024 15:42:52 +0000 Subject: [PATCH 5/8] update to `transform_logit()` --- R/param_engine_partykit.R | 2 +- man/conditional_min_criterion.Rd | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/R/param_engine_partykit.R b/R/param_engine_partykit.R index a8001ad6..3929e1df 100644 --- a/R/param_engine_partykit.R +++ b/R/param_engine_partykit.R @@ -15,7 +15,7 @@ #' 0.99997 in the natural units. For several test types, this parameter #' corresponds to `1 - {p-value}`. #' @export -conditional_min_criterion <- function(range = c(1.386294, 15), trans = scales::logit_trans()) { +conditional_min_criterion <- function(range = c(1.386294, 15), trans = scales::transform_logit()) { dials::new_quant_param( type = "double", range = range, diff --git a/man/conditional_min_criterion.Rd b/man/conditional_min_criterion.Rd index 136b8901..85ca58fb 100644 --- a/man/conditional_min_criterion.Rd +++ b/man/conditional_min_criterion.Rd @@ -16,7 +16,7 @@ An object of class \code{character} of length 2. \usage{ conditional_min_criterion( range = c(1.386294, 15), - trans = scales::logit_trans() + trans = scales::transform_logit() ) values_test_type From 2848924cabb0a8887814d3c5bfbbd2b993a2cdb7 Mon Sep 17 00:00:00 2001 From: Hannah Frick Date: Wed, 21 Feb 2024 15:44:49 +0000 Subject: [PATCH 6/8] update to `transform_log()` --- R/space_filling.R | 2 +- man/grid_max_entropy.Rd | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/R/space_filling.R b/R/space_filling.R index e9da5082..b23cdec9 100644 --- a/R/space_filling.R +++ b/R/space_filling.R @@ -35,7 +35,7 @@ #' penalty(), #' epochs(), #' activation(), -#' learn_rate(c(0, 1), trans = scales::log_trans()), +#' learn_rate(c(0, 1), trans = scales::transform_log()), #' size = 10, #' original = FALSE #' ) diff --git a/man/grid_max_entropy.Rd b/man/grid_max_entropy.Rd index f502e0b3..50900838 100644 --- a/man/grid_max_entropy.Rd +++ b/man/grid_max_entropy.Rd @@ -147,7 +147,7 @@ grid_max_entropy( penalty(), epochs(), activation(), - learn_rate(c(0, 1), trans = scales::log_trans()), + learn_rate(c(0, 1), trans = scales::transform_log()), size = 10, original = FALSE ) From b76619c16eaa95de0ffaa8c5536eb2faf727f3dd Mon Sep 17 00:00:00 2001 From: Hannah Frick Date: Wed, 21 Feb 2024 15:52:15 +0000 Subject: [PATCH 7/8] update to `transform_sqrt()` --- tests/testthat/test-aaa_values.R | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tests/testthat/test-aaa_values.R b/tests/testthat/test-aaa_values.R index 6bd36f64..ea50ae06 100644 --- a/tests/testthat/test-aaa_values.R +++ b/tests/testthat/test-aaa_values.R @@ -54,7 +54,7 @@ test_that("sequences - doubles", { type = "double", range = c(0.5, 1.5), inclusive = c(TRUE, TRUE), - trans = sqrt_trans(), + trans = scales::transform_sqrt(), label = c(param = "param") ) param_with_values <- @@ -100,7 +100,7 @@ test_that("sequences - integers", { type = "integer", range = c(2.1, 5.3), inclusive = c(TRUE, TRUE), - trans = sqrt_trans(), + trans = scales::transform_sqrt(), label = c(param = "param") ) param_with_values <- @@ -180,7 +180,7 @@ test_that("sampling - integers", { type = "integer", range = c(2.1, 5.3), inclusive = c(TRUE, TRUE), - trans = sqrt_trans(), + trans = scales::transform_sqrt(), label = c(param = "param") ) int_seq <- From eb0afa358e1e7c4c1073ba8f392499f264dce7e4 Mon Sep 17 00:00:00 2001 From: Hannah Frick Date: Wed, 21 Feb 2024 16:02:19 +0000 Subject: [PATCH 8/8] update NEWS --- NEWS.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/NEWS.md b/NEWS.md index eb703c4f..7d62c3ac 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,6 +1,8 @@ # dials (development version) -* Improving error messages by switching to cli (#315). +* Improving error messages by switching to cli (#315, #317, #321). + +* Update usage of tranformation functions from the scales package to their new names and require the corresponding version v1.3.0 (#323). # dials 1.2.0