tidymodels / tidymodels/embed

step_lencode_mixed() Documentation Typo

Open Beginner friendly
#277 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
R
Stars
146
Forks
23
PR merge metrics
No merged PRs in 30d

Description

Thank you for your work on this package.

The problem

I think there's a typo in the documentation of the step_lencode_mixed() function. The documentation states in the Details section:

A hierarchical generalized linear model is fit using lme4::lmer() or lme4::glmer(), depending on the nature of the outcome, and no intercept via
lmer(outcome ~ 1 + (1 | predictor), data = data, ...)

Shouldn't it say: ', and an intercept via' instead? The lmer formula shown has an intercept.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the documentation for step_lencode_mixed() and read its Details section alongside the shown lmer() formula. Correct the wording about the intercept so it matches the formula, then check that the rendered documentation states the intended behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
90/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.