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

More documentation, especially intuition and examples, without referring to Stata #152

Open
dfrankow opened this issue Jun 25, 2020 · 1 comment

Comments

@dfrankow
Copy link

@dfrankow dfrankow commented Jun 25, 2020

Thanks for your work on margins. We use it quite a bit.

For my own edification, I was trying to understand how margins really works. Your documentation references Stata, which I've never used.

I started reading the Stata margins docs. Stata example 1 made complete sense to me (difference in preds for all data points setting sex first to "male", then to "female"), and I was able to recreate their (simple) calculations.

However, none of the examples I read seem to correspond closely to the first example in your margins docs (mtcars, cyl, wt, hp).

I think it would be useful to describe in the docs the types of mathematical quantities and calculations that go into calculating the margins to someone who doesn't know Stata, and doesn't have the Stata manual, but has a reasonable understanding of mathematics.

Ideally I'd get the intuition (e.g., "difference between predictions on the data set when setting the sex of all data points to 'male', and setting the sex of all data points to 'female'), along with an example that I could compute by hand to make sure I understood it.

Thanks for your consideration.

@leeper
Copy link
Owner

@leeper leeper commented Jun 26, 2020

Thanks. Good feedback!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.