RStan Getting Started page is wrong in multiple places and confusing people
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 1.1k
- Forks
- 266
- Avg merge
- 2h 56m
- Merged PRs (30d)
- 1
Description
The RStan Getting Started page is out-of-date in many places and is understandably causing confusion (e.g. here but also many others).
-
It says the latest release is in 2019 (edit: I just fixed that)
-
Configuration of the C++ Toolchain section has instructions for Windows (e.g., -march=native) that we know are wrong. Can someone who knows Windows fix this?
-
The How to Use RStan section has a comment about startup messages for windows users that I think is probably out-of-date now after https://github.com/stan-dev/rstan/pull/802.
-
It might be wrong for Macs running an older OS (see e.g. https://github.com/stan-dev/rstan/issues/799)
-
Maybe wrong in other places too
Edit: I just added a note at the top pointing Windows users to the discourse thread with Windows instructions, but this should be removed and the getting started page updated once resubmitted to CRAN.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the RStan Getting Started wiki page, especially the Configuration of the C++ Toolchain and How to Use RStan sections. Review the linked Windows Discourse thread, pull request #802, and issue #799 to verify which guidance is outdated across Windows and older macOS versions. Done means the page reflects current instructions and no longer needs the temporary Windows note after CRAN resubmission.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100