privacytoolsproject / PSI-Library

R library of differentially private algorithms for exploratory data analysis
6 stars 7 forks source link

Integrate sweave/sphynx #38

Closed globusharris closed 5 years ago

globusharris commented 5 years ago

I've been looking into this and am not convinced Sweave would add any features that aren't already covered with use of roxygen2 and vignettes. Jury's still out on sphinx.

Here are the features I think we ought to have:

  1. Help documentation for all functions, including runnable examples
  2. Citation generation and reference generation like what's described in the Interpreting Zelig paper (section 3.1).
  3. Extensive outward-facing documentation for those who are unfamiliar with differential privacy.

After looking more into how roxygen2 works, it looks like the examples under an @example in the comment blocks are actually run by the package, and thus this is sufficient for the first point. The third is covered by vignettes, which could be extended with sweave if we felt like it but I don't see a clear need. So, point 2 is the only real thing we need to add (right now, citations are just stuck in comments). Looking into ways to do this now.

globusharris commented 5 years ago

For citations (see point 2 above):

globusharris commented 5 years ago

Looks like roxygen2 actually also has a reference tag, so we can just use that. The only bummer here is that there's not a good way of, say, generating all of the citations in the package (that I can find).