datacamp / datacamp/rdocumentation-2.0

rnorm and rlnorm documentation erroneously request var and var log instead of sd and sd log, respectively

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

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
301
Forks
54
Avg merge
16h 19m
Merged PRs (30d)
1

Description

According to the documentation, rnorm requests (n, mean, var) but it draws from a distribution that assumes it's (n, mean, sd).
Same issue for rlnorm.

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

Locate the documentation entries for R's rnorm and rlnorm functions and inspect their parameter descriptions. Compare the documented arguments with the issue's stated sd and sdlog behavior, then update both entries so they no longer request var or var log. Done when the documentation accurately names the standard-deviation parameters for both functions.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.