JuliaStats / GLM.jl

Generalized linear models in Julia
Other
593 stars 114 forks source link

Docs for not using a DataFrame #454

Open KronosTheLate opened 2 years ago

KronosTheLate commented 2 years ago

This PR adds documentation on how to do a fit without using a DataFrame, as suggested by @pdeffebach in this thread.

This relativly small addition to the docs closes https://github.com/JuliaStats/GLM.jl/pull/453, and satisfies to issues raised in https://discourse.julialang.org/t/the-simplest-linear-fit-with-glm/71316/11, by my estimation.

nalimilan commented 2 years ago

Thanks. Though rather than adding examples to a section which is currently organized by GLM type, it would be nice to explain in the "Home" section (e.g. in "Fitting GLM models") the different ways one can pass data, with a simple example. Currently that section is really lacking.

KronosTheLate commented 2 years ago

Thanks yourself, for the package ^_^

When you say "Organized by GLM type", you mean with a dataframe as input? In that case I agree, that a new section with the examples with data as arrays would be better.

I will have a look at what part of this I think would fit better in the "Home" section.

nalimilan commented 2 years ago

When you say "Organized by GLM type", you mean with a dataframe as input?

I mean that currently we have one example for each kind of GLM family (linear model, negative binomial...). Each of these can be fitted by passing a data frame, a named tuple, matrices, etc. Since these are orthogonal, better document them in different places to avoid duplicating all families for all input data types.

KronosTheLate commented 2 years ago

Right, that makes sense.

Alternativly, a page on how to read, understand and write a @formula expression would be very helpful I think, because understanding it well is so key to being able to express the problem inside the GLM package. So perhaps a page dedicated to showing different @formula's and the equivalent matrices would be good? And then, if the translation from @formula to matrix is well established, then the current documentation would be sufficient.

nalimilan commented 2 years ago

Yes we really need more complete docs.