Skip to content

Commit

Permalink
Address comments
Browse files Browse the repository at this point in the history
  • Loading branch information
galenlynch committed Jan 16, 2020
1 parent b78ac9a commit a038023
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions src/negbinfit.jl
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,15 @@ end
kwargs...)
Fit a negative binomial generalized linear model to data, while simultaneously
estimating the shape parameter θ. `maxIter`, and `verbose` correspond
to the keyword arguments of the same name used by [`glm`](@ref). Extra arguments
and keyword arguments will be passed to [`glm`](@ref).
estimating the shape parameter θ. Extra arguments and keyword arguments will be
passed to [`glm`](@ref).
# Keyword Arguments
- `initialθ::Real=Inf`: Starting values for shape parameter θ. If it is `Inf`
- `initialθ::Real=Inf`: Starting value for shape parameter θ. If it is `Inf`
then the initial value will be estimated by fitting a Poisson distribution.
- `maxIter::Integer=30`: See `maxIter` for [`glm`](@ref)
- `convTol::Real=1.0e-6`: See `convTol` for [`glm`](@ref)
- `verbose::Bool=false`: See `verbose` for [`glm`](@ref)
"""
function negbin(F,
D,
Expand Down

0 comments on commit a038023

Please sign in to comment.