Skip to content

Commit 8ff3d24

Browse files
be-marcclaude
andauthored
docs: fix typos and populate cspell dictionary (#162)
Fix three genuine typos in roxygen documentation: - `ìters` -> `iters` (FSelectorBatchGeneticSearch) - `inversed` -> `inverse` (EnsembleFSResult) - `permutated` -> `permuted` (FSelectorBatchShadowVariableSearch) Populate the shared cspell dictionary with legitimate package names, jargon, author surnames, and abbreviations so cspell passes cleanly. Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
1 parent b067604 commit 8ff3d24

8 files changed

Lines changed: 104 additions & 9 deletions

.cspell/project-words.txt

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,99 @@
11
# Project-specific words — commit and share with the team.
22
# Add words here (or via "Add to project dictionary" in VS Code / Cursor).
3+
abeel
4+
Aittokallio
5+
autotest
6+
bbotk
7+
Bengio
8+
Bergstra
9+
Bernd
10+
bibentries
11+
bibtex
12+
Bischl
13+
borda
14+
cheatsheet
15+
cindex
16+
Classif
17+
clbk
18+
clbks
19+
clust
20+
Codomain
21+
CRAN
22+
datatable
23+
donttest
24+
eefsr
25+
efsr
26+
efsrs
27+
evals
328
faggregate
29+
fselect
30+
fselector
31+
fselectors
32+
genalg
33+
guyon
34+
hedou
35+
Hepp
36+
Hyperparameters
37+
Insample
38+
jaccard
39+
lightswitch
40+
lockfiles
41+
logloss
42+
lrns
43+
López
44+
mathjax
45+
Mayr
46+
meinshausen
47+
mirai
48+
msrs
49+
nfeatures
50+
nocov
51+
nolint
52+
nonspam
53+
nrows
54+
omics
55+
ORCID
56+
paramtest
57+
pdata
58+
phash
59+
pkgdown
60+
pkgdowntemplate
61+
proba
62+
processx
63+
Pseudovariables
64+
rbga
65+
rdname
66+
redocument
67+
Regr
68+
renv
69+
resamplings
70+
RFECV
71+
Roundbracket
72+
rowwise
73+
roxygen
74+
Roxygenize
75+
rpart
76+
Rscript
77+
rsmp
78+
rsmps
79+
saeys
80+
Schratz
81+
seealso
82+
Squarebracket
83+
stabm
84+
stackoverflow
85+
Stefanski
86+
subsamples
87+
Subsampling
88+
subsetting
89+
testthat
90+
tgen
91+
tgens
92+
trafoed
93+
trms
94+
tsks
95+
twoclass
96+
uhash
97+
Uninstantiated
98+
yolobox
99+
Zobolas

R/EnsembleFSResult.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -460,7 +460,7 @@ EnsembleFSResult = R6Class(
460460
#' Two options are available for the Pareto front:
461461
#' - `"empirical"` (default): returns the empirical Pareto front.
462462
#' - `"estimated"`: the Pareto front points are estimated by fitting a linear model
463-
#' with the inversed of the number of features (\eqn{1/x}) as input
463+
#' with the inverse of the number of features (\eqn{1/x}) as input
464464
#' and the associated performance scores as output.
465465
#'
466466
#' This method is useful when the Pareto points are sparse and the front assumes a convex shape if better

R/FSelectorBatchGeneticSearch.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
#' @section Control Parameters:
1313
#' For the meaning of the control parameters, see [genalg::rbga.bin()].
1414
#' [genalg::rbga.bin()] internally terminates after `iters` iteration.
15-
#' We set `ìters = 100000` to allow the termination via our terminators.
16-
#' If more iterations are needed, set `ìters` to a higher value in the parameter set.
15+
#' We set `iters = 100000` to allow the termination via our terminators.
16+
#' If more iterations are needed, set `iters` to a higher value in the parameter set.
1717
#'
1818
#' @family FSelector
1919
#' @export

R/FSelectorBatchShadowVariableSearch.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
#'
66
#' @description
77
#' Feature selection using the Shadow Variable Search Algorithm.
8-
#' Shadow variable search creates for each feature a permutated copy and stops when one of them is selected.
8+
#' Shadow variable search creates for each feature a permuted copy and stops when one of them is selected.
99
#'
1010
#' @details
1111
#' The feature selection terminates itself when the first shadow variable is selected.

inst/WORDLIST

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,5 @@ getters
4141
iteratively
4242
mlr
4343
parallelize
44-
permutated
4544
saveRDS
4645
th

man/ensemble_fs_result.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/mlr_fselectors_genetic_search.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/mlr_fselectors_shadow_variable_search.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)