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

Docs for not using a DataFrame #454

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

Conversation

KronosTheLate
Copy link

@KronosTheLate KronosTheLate commented Nov 11, 2021

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 #453, and satisfies to issues raised in https://discourse.julialang.org/t/the-simplest-linear-fit-with-glm/71316/11, by my estimation.

This PR adds documentation on how to do a fit without using a DataFrame, as suggested by @pdeffebach in [this thread](https://discourse.julialang.org/t/the-simplest-linear-fit-with-glm/71316/11).
This commit adds another very basic example, that I would have appreciated when I first met GLM. It also links to the documentation of `@formula`, which I think is highly relevant.
@nalimilan
Copy link
Member

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
Copy link
Author

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
Copy link
Member

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
Copy link
Author

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
Copy link
Member

Yes we really need more complete docs.

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