Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't recommend rstan::read_stan_csv #1018

Merged
merged 1 commit into from
Jul 31, 2024
Merged

Conversation

jgabry
Copy link
Member

@jgabry jgabry commented Jul 31, 2024

Submission Checklist

  • Run unit tests
  • Declare copyright holder and agree to license (see below)

Summary

It seems like rstan::read_stan_csv() is not guaranteed to successfully handle CmdStan CSVs. We mention read_stan_csv various times in the CmdStanR doc so this PR removes those mentions. At this point I think cmdstanr and posterior provide the necessary functionality that this isn't losing anything important. What do you think @andrjohns?

Copyright and Licensing

Please list the copyright holder for the work you are submitting
(this will be you or your assignee, such as a university or company):
Columbia University

By submitting this pull request, the copyright holder is agreeing to
license the submitted work under the following licenses:

@jgabry jgabry added the documentation Improvements or additions to documentation label Jul 31, 2024
@jgabry jgabry requested a review from andrjohns July 31, 2024 17:38
Copy link
Collaborator

@andrjohns andrjohns left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hard agree!

@jgabry jgabry merged commit e45fa00 into master Jul 31, 2024
11 checks passed
@jgabry jgabry deleted the remove-mentions-of-read_stan_csv branch July 31, 2024 19:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants