From 942c68ee2bed3b8c615eddde7de31fa27eee7bbb Mon Sep 17 00:00:00 2001 From: Simone Carlo Surace <51025924+simsurace@users.noreply.github.com> Date: Sat, 2 Sep 2023 15:00:21 +0200 Subject: [PATCH 1/2] Remove outdated comment about Wikipedia Related to https://github.com/JuliaStats/Distributions.jl/pull/1734 --- src/likelihoods/negativebinomial.jl | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/likelihoods/negativebinomial.jl b/src/likelihoods/negativebinomial.jl index f663d4c..df2873c 100644 --- a/src/likelihoods/negativebinomial.jl +++ b/src/likelihoods/negativebinomial.jl @@ -18,9 +18,9 @@ defines in what parametrization the latent function is used, and contains the ot ## `NBParam` predefined types -### `NBParamProb` types with `p = invlink(f)` the probability of success -- [`NBParamSuccess`](@ref): This is the definition used in [`Distributions.jl`](https://juliastats.org/Distributions.jl/latest/univariate/#Distributions.NegativeBinomial). -- [`NBParamFailure`](@ref): This is the definition used in [Wikipedia](https://en.wikipedia.org/wiki/Negative_binomial_distribution). +### `NBParamProb` types with `p = invlink(f)` the probability of success/failure +- [`NBParamSuccess`](@ref): Here `p = invlink(f)` is the probability of success. This is the definition used in [`Distributions.jl`](https://juliastats.org/Distributions.jl/latest/univariate/#Distributions.NegativeBinomial). +- [`NBParamFailure`](@ref): Here `p = invlink(f)` is the probability of a failure ### `NBParamMean` types with `μ = invlink(f)` the mean/expected number of events From f54c19f0bbbcba6f79fc454f44674180af2741ce Mon Sep 17 00:00:00 2001 From: Simone Carlo Surace <51025924+simsurace@users.noreply.github.com> Date: Wed, 6 Sep 2023 21:52:48 +0200 Subject: [PATCH 2/2] Improve wording in docstring --- src/likelihoods/negativebinomial.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/likelihoods/negativebinomial.jl b/src/likelihoods/negativebinomial.jl index df2873c..d8f78a2 100644 --- a/src/likelihoods/negativebinomial.jl +++ b/src/likelihoods/negativebinomial.jl @@ -18,7 +18,7 @@ defines in what parametrization the latent function is used, and contains the ot ## `NBParam` predefined types -### `NBParamProb` types with `p = invlink(f)` the probability of success/failure +### `NBParamProb` types with `p = invlink(f)` the probability of success or failure - [`NBParamSuccess`](@ref): Here `p = invlink(f)` is the probability of success. This is the definition used in [`Distributions.jl`](https://juliastats.org/Distributions.jl/latest/univariate/#Distributions.NegativeBinomial). - [`NBParamFailure`](@ref): Here `p = invlink(f)` is the probability of a failure