search

nhejazi / txshift

:package: :game_die: R/txshift: Efficient Estimation of the Causal Effects of Stochastic Interventions, with Corrections for Outcome-Dependent Sampling
https://codex.nimahejazi.org/txshift
Other
13 stars 4 forks source link

Can you provide examples for all the functions #59

Closed joethorley closed 4 years ago

joethorley commented 4 years ago

Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).

joethorley commented 4 years ago

https://github.com/openjournals/joss-reviews/issues/2447

nhejazi commented 4 years ago

Thanks for raising this point. This package isn't intended to expose many user-facing functions - primarily, these are just txshift() and msm_vimshift(), alongside any methods exposed for the S3 classes these introduce (e.g., summary, plot). Following CRAN guidelines, we've provided examples for each of these functions and methods; however, there are a number of internal functions that are not intended to be user-facing.

We hope that this alleviates some of the concern around functions without examples in their documentation but would be happy to discuss any lingering concerns further.

joethorley commented 4 years ago

@nhejazi - I saw the detailed documentation on various internal functions and assumed they were exported. You are quite right and I am closing this issue.