Skip to content

Intro chapter#961

Open
bob-carpenter wants to merge 10 commits into
masterfrom
intro-chapter
Open

Intro chapter#961
bob-carpenter wants to merge 10 commits into
masterfrom
intro-chapter

Conversation

@bob-carpenter

Copy link
Copy Markdown
Member

Submission Checklist

  • Builds locally
  • New functions marked with <<{ since VERSION }>>
  • Declare copyright holder and open-source license: see below

Summary

This is adding two introductory chapters, "The Stan Ecosystem" and "How Stan Works".

The first chapter summarizes the projects and how they fit together. There's a diagram of GitHub repos and dependencies for the core modules. The second chapter summarizes the reference manual with a couple short examples.

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):

Simons Foundation

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

@WardBrian WardBrian left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This looks good overall, thanks. Most of my comments are suggestions for places for more cross linking to other doc, which I think never hurts

Comment thread src/stan-users-guide/img/stan-ecosystem.png
Comment thread src/stan-users-guide/ecosystem.qmd Outdated
Comment thread src/stan-users-guide/ecosystem.qmd Outdated
Comment thread src/stan-users-guide/ecosystem.qmd Outdated

### Stan GitHub organization

![The core Stan foundation and interface ecosystem as organized in GitHub repositories. The color coding is based on external interface language.](img/stan-ecosystem.png){#fig-stan-projects width=75% fig-align="center"}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Not sure how stan-ecosystem.png was created, but note that Quarto supports both Mermaid and Graphviz natively: https://quarto.org/docs/authoring/diagrams.html

The former would even let the nodes be clickable

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

tikz. I didn't want to include the LaTeX source as I'm not sure mathjax could handle something like that.

Comment thread src/stan-users-guide/ecosystem.qmd Outdated
Comment on lines +208 to +212
Stan such as the `rstanarm` and `brms`, both of which are based on R's
expression language for regressions. The project also develops and
maintains visualization and model comparison tools like `posterior`
and `loo` (in R; for Python, similar functionality is available through
`ArviZ`).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Every package might as well be a link IMO

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

You're right. I completely reorganized and filled in a bit more detail and grouped better.

Comment thread src/stan-users-guide/ecosystem.qmd Outdated
Comment thread src/stan-users-guide/how-stan-works.qmd Outdated
Comment thread src/stan-users-guide/how-stan-works.qmd Outdated
Comment thread src/stan-users-guide/how-stan-works.qmd Outdated
Comment thread src/stan-users-guide/index.qmd Outdated
@bob-carpenter

Copy link
Copy Markdown
Member Author

@WardBrian: This is ready to review again. I think I covered all your requests---I left the ones unresolved that were more judgement calls.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants