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

Add output example interpretation #27

Open
akarlinsky opened this issue Nov 20, 2021 · 4 comments
Open

Add output example interpretation #27

akarlinsky opened this issue Nov 20, 2021 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@akarlinsky
Copy link

The arXiv paper shows the results of zaman analysis for several papers,
usually showing the number and share of observations dropped in the form of a table.

The example in the README just shows some plots, which I'm not really sure how to interpret.
Adding an "annotated output" for the example via table and/or explaining what the plots show would be really great IMO.

@rgiordan rgiordan self-assigned this Dec 4, 2021
@rgiordan rgiordan added the documentation Improvements or additions to documentation label Dec 4, 2021
@rgiordan
Copy link
Owner

rgiordan commented Dec 4, 2021

This is a great suggestion. I'll work on putting this together when I get a chance.

@maswiebe
Copy link

maswiebe commented Apr 2, 2022

+1, I'm having trouble understanding the output in the readme example.

@rgiordan
Copy link
Owner

I put another example file, examples/interpreting_output.R, in #37. I'd be interested to hear if it's helpful.

Perhaps a standalone function to produce tables similar to those in the paper would still be helpful.

@maswiebe
Copy link

Nice, this was helpful! A standalone function would also be helpful, since I would be making one myself.

Note a small typo on line 70: 'for exmample'.

Also, the intuition for "large residuals and large |x1|" is high influence via large residuals and high leverage of x1, right? Might be helpful to make that explicit.

# For example, you can graph the reruns and predictions versus one another like so:
ggplot(summary_df) +
  geom_point(aes(x=prediction, y=rerun, color=param_name, shape=metric)) +
  geom_abline(aes(slope=1, intercept=0))

This graph isn't very clear, because the scale is so different for x1 and x2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants