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

Test and document #3

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

Conversation

djinnome
Copy link

@djinnome djinnome commented Jan 7, 2025

Create unit tests and documentation for all previously undocumented, untested code that supports the simplify algorithm.

hmhummel and others added 30 commits July 11, 2024 16:40
This file contains all 3 test cases compiled into 1 file.
…n unit test with causal.effect simp = TRUE
delete previously-created simplify .Rd documentation in order to ensure no conflict with roxygen-created simplify (cannot modify .Rd files by hand; must use roxygen)
…d Encoding = UTF-8. Updated NAMESPACE file to include export(simplify). Updated simplify.R to include working documentation when ?simplify is run.
…simplify.Rd documentation. Added export(join) to NAMESPACE.
…ion documentation files with the test example.
@santikka
Copy link
Owner

santikka commented Jan 9, 2025

@hmhummel @djinnome thanks for the amazing work! I didn't even realize you had been working on the package.

I see that some previously internal functions are now exported (simplify, join), is there some motivation for this?

Also, some other internals have documentation files (parse.expression, powerset, insert), not sure if this is ok for CRAN or not.

@djinnome
Copy link
Author

Hi @santikka this project was part of an internship that @hmhummel completed with me last summer. I have a python implementation of many causal, counterfactual, and transportability algorithms (including your surrogate outcomes algorithm) in a project called y0, and I read with interest your simplification paper. The goal of the internship was to implement your simplification algorithm in y0. However, aside from the paper itself, there was little documentation on the functions that implement the simplification algorithm, so our first step was to document those functions so that we (and hopefully others) understood how to use them. The second step was to port them to the python implementation of causaleffect, and the third step was to port from causaleffectpy to y0. Unfortunately, the internship ended before Haley could complete the 2nd and 3rd steps, but you can see the quality of her handiwork on step 1.

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.

3 participants