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

Minor fixes to beta function parameters and clarifying text for gamma distribution #640

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

mikegilchrist
Copy link
Contributor

Submission Checklist

  • Builds locally -- see below
  • [x ] New functions marked with `r since("VERSION")`
  • [x ] Declare copyright holder and open-source license: see below

Summary

Minor improvements and fixes to documentation.

Note I get tex build errors which seem unrelated to my changes

$ ./build.py 2 32
render functions-reference as pdf
output file: stan_docs/docs/2_32/functions-reference-2_32.pdf
render functions-reference as html
output dir: stan_docs/docs/2_32/functions-reference
render reference-manual as pdf
output file: stan_docs/docs/2_32/reference-manual-2_32.pdf
render reference-manual as html
output dir: stan_docs/docs/2_32/reference-manual
render stan-users-guide as pdf
Command Rscript -e "bookdown::render_book('index.Rmd', output_format='bookdown::pdf_book')" failed
processing file: _main.Rmd
output file: _main.knit.md
! TeX capacity exceeded, sorry [input stack size=10000]. \font@name -> \T1/bch/b/n/17.28
l.16293 ...org/wiki/Amdahl\textquotesingle{}s_law}
{Amdahl's
Error: LaTeX failed to compile _main.tex. See https://yihui.org/tinytex/r/#debugging for debugging tips. See _main.log for more info.
Execution halted
Traceback (most recent call last):
File "stan_docs/./build.py", line 129, in
main()
File "stan_docs/./build.py", line 125, in main
make_docs(docspath, stan_version, doc, formats)
File "stan_docs/./build.py", line 56, in make_docs
shexec(command)
File "stan_docs/./build.py", line 36, in shexec
raise Exception(ret.returncode)
Exception: 1

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

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

Copy link
Contributor

@bob-carpenter bob-carpenter left a comment

Choose a reason for hiding this comment

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

Thanks for submitting and sorry to have missed this earlier. Other than for making the expectation and variance notation consistent with the rest of our doc these changes look good. I'll just go ahead and fix myself if there's not a response.

\in \mathbb{R}^+$, \[ \text{Gamma}(y|\alpha,\beta) =
\frac{\beta^{\alpha}} {\Gamma(\alpha)} \, y^{\alpha - 1}
\exp(-\beta \, y) . \]

Under the shape and rate formulation of the Gamma distribution, $E(y) = \alpha/\beta$ and $\var(y) = \alpha/\beta^2$.
Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry I didn't see this before. This is fine, but we've used \mathbb{E}[y] for expectations and typically Y for random variables. Also \mathrm{var}[y] (though that may be what \var does?).

@avehtari
Copy link
Contributor

@bob-carpenter were you going to do something more for this?

@bob-carpenter
Copy link
Contributor

Does this need a more formal review? It has a conflict now that needs to be resolved. Happy to review after that.

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.

3 participants