salbalkus / CausalTables.jl

A new type of Table to store and simulate data for causal inference in Julia.
https://salbalkus.github.io/CausalTables.jl/
MIT License
0 stars 0 forks source link

Documentation Review #20

Open salbalkus opened 4 months ago

salbalkus commented 4 months ago

Hi @nhejazi,

As we discussed, I've narrowed down the feedback I'm looking for on this package to something more specific for you. Namely, would you mind quickly reviewing the quick start tutorial for this package?

Specifically, it would be much appreciated if you could visit https://salbalkus.github.io/CausalTables.jl/ and read it (Just this "Home" page, though if anything is confusing you're welcome to read in more detail on the other sub-pages). I'm mainly hoping for feedback on:

  1. Does this page give you a sense of what the package does from the perspective of someone who has never seen it before?
  2. Would the page benefit from re-organizing the order of the sections or content?
  3. Is there any other functionality you think the package needs before releasing it on Julia's General Repository?
  4. Are there any additional questions you'd want answered on the package homepage?

If you have any other feedback on the documentation, I'm also open to it as well!

nhejazi commented 3 months ago

thanks for narrowing the scope @salbalkus, here are some comments related to the prompts above,

  1. yes, the documentation is clear but might not characterize as "someone who has never seen it before," as it might help to explain the motivations behind several functions that are implemented, e.g., condensity(), conmean():
    • why might the user care about computing conditional densities or conditional means? these are extremely useful quantities, but maybe a little bit more of the motivation relevant to causality should be introduced? for example, you might show how to compute a counterfactual mean in the DGP example using a combination of the condensity() and conmean() functions?
    • it might help to also include a simple visualization of the graphical structure encoded in the DGP, e.g., W -> X -> Y and W -> Y
  2. the organization seems clear and easy to follow -- well done!
  3. some minor points below.
  4. see minor points below.

miscellaneous/minor notes:

let's plan to discuss the degree to which incorporating the above minor points is worthwhile prior to an initial release. overall, this is very nicely done!