Update vignettes and readme for 1.0

[jgabry]

One of the last things we should do before the 1.0 release is to update the main vignette, which currently refers to CmdStanR being in beta.

Also the readme needs to be updated

[jgabry]

Also, remember that the opencl vignette doesn't run unless the CMDSTANR_OPENCL_TESTS environment variable is set. And when publishing the OPENCL vignette to the website with v1.0 (and eventually to CRAN) we need to decide if we want it to be run on linux or if it's ok if I generate it on mac (does it matter for demonstrating the timings?).

[rok-cesnovar]

Yeah, I will run it with my GPU whenever we will do that. Not a problem.

[jgabry]

The only issue is that CRAN allows each package to have only a single maintainer at a time and that person has to submit the releases. So I can't be the maintainer but have you generate one of the vignettes (as far as I know, but maybe there's a workaround). So I think that gives us a few alternatives:

(a) I'm the CRAN maintainer and the vignettes are all generated on my mac
(b) You're the CRAN maintainer and the vignettes are all generated on whatever linux machine you're using
(c) We don't include the vignettes with the CRAN package, just links to the ones on the CmdStanR website. This allows either of us to be CRAN maintainer and either of us to upload any of the vignettes to the CmdStanR website.

I don't really care who the maintainer is (I'm happy to do it or not do it), so I guess if we want to make sure the opencl vignette is generated by you then we should do option (b) or (c). I'm ok with either of those options.

[rok-cesnovar]

We could also just not include the OpenCL vignette right?

[jgabry]

Yeah that's true. We could have the OpenCL vignette only be on the website and not on CRAN. That may be the best option.

[jgabry]

Yeah that's true. We could have the OpenCL vignette only be on the website and not on CRAN. That may be the best option.

I will add this to PR #595. I think we can put the OpenCL vignette in a subdirectory and have CRAN ignore it but pkgdown put it online.

[danielinteractive]

@jgabry Hi Jonah, quick question from the sidelines - do you plan to put cmdstanr on CRAN soon?

[jgabry]

do you plan to put cmdstanr on CRAN soon?

Yes!

There are only a few more issues to address before we do a v1.0 release:

https://github.com/stan-dev/cmdstanr/milestone/2

And really only two of those issues involve much work (#582 and #534).

[danielinteractive]

Hi @jgabry , so from our side we would be very interested to see cmdstanr on CRAN to enable downstream packages to be on CRAN too.
What do you think - where could we help with tackling cmdstanr issues? I would be happy also to have a quick video call with you / the team to get started. Thanks!