Skip to content

Slighltly improve coefnames with no intercept #301

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Slighltly improve coefnames with no intercept #301

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/terms.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -567,13 +567,15 @@ vectorize(x) = [x]
"""
coefnames(term::AbstractTerm)

Return the name(s) of column(s) generated by a term. Return value is either a
`String` or an iterable of `String`s.
Return the name(s) of column(s) generated by a term.

Return value is either a `String`, an iterable of `String`s or the empty vector
if there is no associated column (e.g. `coefnames(InterceptTerm{false}())`).
Comment on lines +572 to +573
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Return value is either a `String`, an iterable of `String`s or the empty vector
if there is no associated column (e.g. `coefnames(InterceptTerm{false}())`).
Return value is either a `String`, an iterable of `String`s, the empty vector
if there is no associated column (e.g. `coefnames(InterceptTerm{false}())`), or
(in the case of a `FormulaTerm`) a two tuple of any of the above (corresponding
to `coefnames` applied to the left- and right-hand sides of the formula).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if I copied and adapted the docstring for termnames(t::FormulaTerm) instead? My goal was to make the two functions consistent, and the behavior for formulas seems different enough to deserve a separate docstring.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bump.


See also [`termnames`](@ref).
"""
StatsAPI.coefnames(t::FormulaTerm) = (coefnames(t.lhs), coefnames(t.rhs))
StatsAPI.coefnames(::InterceptTerm{H}) where {H} = H ? "(Intercept)" : []
StatsAPI.coefnames(::InterceptTerm{H}) where {H} = H ? "(Intercept)" : String[]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tangential as this code is predates this PR but it's kind of odd IMO that coefnames can return a String rather than a container. The name is plural so it sounds like it should give you some collection of names, even if said collection has one element (or none).

Copy link
Member

@palday palday Sep 7, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would not be opposed to always returning a container, even when it's just one element, but that would be technically breaking for coefnames albeit not termnames (because `termnames hasn't appeared in a release yet)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's true that the name is plural, but I'm not sure returning a single string is a problem in practice. Are people really likely to call this on objects which could either be single- or multiple-term? It's not super practical either to get a single-element vector when you know in advance there will be a single value, and in terms of our own implementation it's quite wasteful (though it probably doesn't matter much).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

teh return type is already all over the place since the FormulaTerm one returns a tuple, so I'm not too fussed about it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess that means the current docstring is wrong though...

Copy link
Contributor

@matthieugomez matthieugomez Dec 5, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with @ararslan — always returning a container would be the best choice (and that’s what Julia does everywhere). And yes, it matters for developers that use coefnames inside their functions (as I needed to work around that in my packages)

StatsAPI.coefnames(t::ContinuousTerm) = string(t.sym)
StatsAPI.coefnames(t::CategoricalTerm) =
["$(t.sym): $name" for name in t.contrasts.coefnames]
Expand Down