Skip to content

Commit 3e281f5

Browse files
committed
fixing typos
1 parent 956525b commit 3e281f5

24 files changed

+32
-32
lines changed

R/LearnerAvg.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
#' for `LearnerClassifAvg` and `regr.mse` for `LearnerRegrAvg`).
1515
#' Learned weights can be obtained from `$model`.
1616
#' Using non-linear optimization is implemented in the SuperLearner R package.
17-
#' For a more detailed analysis the reader is refered to
17+
#' For a more detailed analysis the reader is referred to
1818
#' *LeDell, 2015: Scalable Ensemble Learning and Computationally Efficient Variance Estimation*.
1919
#'
2020
#' @section Parameter Set:

R/PipeOp.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
#' @format Abstract [`R6Class`].
88
#'
99
#' @description
10-
#' A [`PipeOp`] represents a tranformation of a given "input" into a given "output", with two stages: "training"
10+
#' A [`PipeOp`] represents a transformation of a given "input" into a given "output", with two stages: "training"
1111
#' and "prediction". It can be understood as a generalized function that not only has multiple inputs, but
1212
#' also multiple outputs (as well as two stages). The "training" stage is used when training a machine learning pipeline or
1313
#' fitting a statistical model, and the "predicting" stage is then used for making predictions
1414
#' on new data.
1515
#'
16-
#' To perform training, the `$train()` function is called which takes inputs and tranforms them, while simultaneously storing information
16+
#' To perform training, the `$train()` function is called which takes inputs and transforms them, while simultaneously storing information
1717
#' in its `$state` slot. For prediction, the `$predict()` function is called, where the `$state` information can be used to influence the transformation
1818
#' of the new data.
1919
#'

R/PipeOpClassBalancing.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
#'
77
#' @description
88
#' Both undersamples a [`Task`][mlr3::Task] to keep only a fraction of the rows of the majority class,
9-
#' as well as oversamples (repeats datapoints) rows of the minority class.
9+
#' as well as oversamples (repeats data points) rows of the minority class.
1010
#'
1111
#' Sampling happens only during training phase. Class-balancing a [`Task`][mlr3::Task] by sampling may be
1212
#' beneficial for classification with imbalanced training data.

R/PipeOpEnsemble.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
#'
5555
#' Should it be necessary to use the output of preceding [`Learner`][mlr3::Learner]s
5656
#' during the "training" phase, then [`PipeOpEnsemble`] should not be used. In fact, if training time behaviour of a [`Learner`][mlr3::Learner] is important, then
57-
#' one should use a [`PipeOpLearnerCV`] instead of a [`PipeOpLearner`], and the ensembling can be done by a [`Learner`][mlr3::Learner] encapsuled by a [`PipeOpLearner`].
57+
#' one should use a [`PipeOpLearnerCV`] instead of a [`PipeOpLearner`], and the ensemble can be created with a [`Learner`][mlr3::Learner] encapsulated by a [`PipeOpLearner`].
5858
#' See [`LearnerClassifAvg`] and [`LearnerRegrAvg`] for examples.
5959
#'
6060
#' @section Fields:

R/PipeOpImpute.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@
7878
#' * `select_cols(task)` \cr
7979
#' ([`Task`][mlr3::Task]) -> `character` \cr
8080
#' Selects which columns the [`PipeOp`] operates on. In contrast to
81-
#' the `affect_columns` parameter. `select_cols` is for the *ineriting class* to determine which columns
81+
#' the `affect_columns` parameter. `select_cols` is for the *inheriting class* to determine which columns
8282
#' the operator should function on, e.g. based on feature type, while `affect_columns` is a way for the *user*
8383
#' to limit the columns that a [`PipeOpTaskPreproc`] should operate on.
8484
#' * `train_imputer(feature, type, context)`\cr

R/PipeOpQuantileBin.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
#' @section Input and Output Channels:
2121
#' Input and output channels are inherited from [`PipeOpTaskPreproc`].
2222
#'
23-
#' The output is the input [`Task`][mlr3::Task] with all affected numeric features replaced by their binded versions.
23+
#' The output is the input [`Task`][mlr3::Task] with all affected numeric features replaced by their binned versions.
2424
#'
2525
#' @section State:
2626
#' The `$state` is a named `list` with the `$state` elements inherited from [`PipeOpTaskPreproc`], as well as:

R/PipeOpScale.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
#' The mean of each numeric feature during training, or 0 if `center` is `FALSE`. Will be subtracted during the predict phase.
3232
#' * `scale` :: `numeric`\cr
3333
#' The root mean square, defined as `sqrt(sum(x^2)/(length(x)-1))`, of each feature during training, or 1 if `scale` is FALSE.
34-
#' During predict phase, feaatures are divided by this.\cr
34+
#' During predict phase, features are divided by this.\cr
3535
#' This is 1 for features that are constant during training if `center` is `TRUE`, to avoid division-by-zero.
3636
#'
3737
#' @section Parameters:

R/PipeOpScaleRange.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
#' @format [`R6Class`] object inheriting from [`PipeOpTaskPreprocSimple`]/[`PipeOpTaskPreproc`]/[`PipeOp`].
66
#'
77
#' @description
8-
#' Linearily transforms numeric data columns so they are between `lower` and `upper`.
8+
#' Linearly transforms numeric data columns so they are between `lower` and `upper`.
99
#' The formula for this is \eqn{x' = a + x * b},
1010
#' where \eqn{b} is \eqn{(upper - lower) / (max(x) - min(x))} and
1111
#' \eqn{a} is \eqn{-min(x) * b + lower}.

R/PipeOpTaskPreproc.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@
136136
#' ([`Task`][mlr3::Task]) -> `character` \cr
137137
#' Selects which columns the [`PipeOp`] operates on, if `$train_dt()` and `$predict_dt()` are overloaded. This function
138138
#' is not called if `$train_task()` and `$predict_task()` are overloaded. In contrast to
139-
#' the `affect_columns` parameter. `select_cols` is for the *ineriting class* to determine which columns
139+
#' the `affect_columns` parameter. `select_cols` is for the *inheriting class* to determine which columns
140140
#' the operator should function on, e.g. based on feature type, while `affect_columns` is a way for the *user*
141141
#' to limit the columns that a [`PipeOpTaskPreproc`] should operate on.\cr
142142
#' This method can optionally be overloaded when inheriting [`PipeOpTaskPreproc`], together with `$train_dt()` and

R/Selector.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
#' A [`Selector`] function is used by different [`PipeOp`]s, most prominently [`PipeOpSelect`] and many [`PipeOp`]s inheriting
77
#' from [`PipeOpTaskPreproc`], to determine a subset of [`Task`][mlr3::Task]s to operate on.
88
#'
9-
#' Even though a [`Selector`] is a `function` that can be written itself, it is preferrable to use the [`Selector`] constructors
9+
#' Even though a [`Selector`] is a `function` that can be written itself, it is preferable to use the [`Selector`] constructors
1010
#' shown here. Each of these can be called with its arguments to create a [`Selector`], which can then be given to the [`PipeOpSelect`]
1111
#' `selector` parameter, or many [`PipeOpTaskPreproc`]s' `affect_columns` parameter. See there for examples of this usage.
1212
#'
@@ -38,7 +38,7 @@
3838
#' }
3939
#' ```
4040
#'
41-
#' It is preferrable to use the [`Selector`] construction functions like `select_type`, `select_grep` etc. if possible, instead of writing custom [`Selector`]s.
41+
#' It is preferable to use the [`Selector`] construction functions like `select_type`, `select_grep` etc. if possible, instead of writing custom [`Selector`]s.
4242
#'
4343
#' @return `function`: A [`Selector`] function that takes a [`Task`][mlr3::Task] and returns the feature names to be processed.
4444
#'

0 commit comments

Comments
 (0)