JSON and R dump format specs in reference manual
Open
Nobody has claimed this yet.
enhancement
good first issue
- Dominant language
- TeX
- Stars
- 43
- Forks
- 133
- Avg merge
- 11h 32m
- Merged PRs (30d)
- 4
Description
Summary:
We should talk about our JSON and R dump formats accepted by CmdStan in the reference manual.
Description:
Note that our JSON format is different than the formats accepted by standard R or Python JSON readers.
Additional Information:
Should R dump be deprecated even in R?
Current Version:
v2.18.0
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 reference manual sections covering CmdStan input formats, then compare the documented JSON and R dump formats with the formats accepted by standard R and Python JSON readers. Resolve whether R dump should be deprecated in R, and consider the work complete when both formats and that deprecation decision are clearly documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100