Closed fweber144 closed 1 year ago
Why props
and not proportions
?
Otherwise, the illustration looks good
Why
props
and notproportions
?
proportions()
was also my first idea, but it already exists in base R (https://stat.ethz.ch/R-manual/R-devel/library/base/html/proportions.html) and unfortunately, it's not a generic. Since prop.table()
is an alias for proportions()
in base R, I thought it would make sense to abbreviate proportions()
by props()
.
Why
props
and notproportions
?
proportions()
was also my first idea, but it already exists in base R (https://stat.ethz.ch/R-manual/R-devel/library/base/html/proportions.html) and unfortunately, it's not a generic. Sinceprop.table()
is an alias forproportions()
in base R, I thought it would make sense to abbreviateproportions()
byprops()
.
We now agreed to rename props()
to cv_proportions()
in an upcoming PR.
This PR starts to address #289.
In particular, this adds the new functions
ranking()
andprops()
, making output elementpct_solution_terms_cv
ofvsel
objects obsolete (but requiring the addition of output elementsolution_terms_cv
tovsel
objects). This also adds a newplot()
method for visualizing the output ofprops()
(more precisely, twoplot()
methods are added, butplot.vsel()
is only a shortcut for first applyingranking.vsel()
and thenplot.ranking()
). For the user-facing changes, see the changes inNEWS.md
.Quick illustration of the new functions:
Dummy ranking proportions for illustrating the color gradient:
As mentioned above, this PR is only a first step towards resolving #289 completely. In the future, I will:
print.vselsummary()
table, containing the diagonal of the matrix of the non-cumulated ranking proportions.plot.vsel()
predictive performance plot, again with the diagonal of the matrix of the non-cumulated ranking proportions. This will be done with the option to restrict this solution path and the ranking proportions to the first few terms. By default, I think we should not restrict them, for consistency with theprint.vselsummary()
table.