llrs / llrs/repo.data

R links not anchored?

Open
#3 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
R
Stars
3
Forks
1
Avg merge
2h 33m
Merged PRs (30d)
1

Description

Some package authors rely on not having other packages with the same alias to not provide an anchor on their package on their links.

For example A3 on a3.lm says:

```
\description{
This convenience function calculates the A3 results specifically for linear regressions. It uses R's \code{\link{glm}} function and so supports logistic regressions and other link functions using the \code{family} argument. For other forms of models you may use the more general \code{\link{a3}} function.
}
```

This assumes that it goes to stats::glm but it could resolve to chantrics::glm or mixlm::glm

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

Start with the A3 example on a3.lm and compare how \link{glm} resolves when stats::glm, chantrics::glm, or mixlm::glm are available. Determine the intended anchoring behavior for package authors and document or test the result; done means links resolve unambiguously without relying on aliases.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.