jeroen / openssl

OpenSSL bindings for R
Other
65 stars 23 forks source link

Add roxygen2 #3

Closed Ironholds closed 9 years ago

Ironholds commented 9 years ago

We should probably use roxygen2 for docs. I'll make a stab at adding that now.

jeroen commented 9 years ago

I'm already doing that: https://github.com/jeroenooms/openssl/blob/master/R/openssl.R

Ironholds commented 9 years ago

Yay!

jeroen commented 9 years ago

The example is really cool too :-) It shows how you can use the openssl rng to replace rnorm and rbinom and stuff by using their cumulative distribution function. We could write about that in the paper to make it more statsy :D

Ironholds commented 9 years ago

Heh; it's the Journal of Statistical Software: mostly my argument is "using this code to generate SHA512 hashes of strings is 5 times faster than using digest to generate MD5s. Use it for cryptography and dataset releases". We could definitely look into dividing the writeup, though.

Okay; what would you think of me:

  1. Shifting all the rand_* functions into a rand.R file, since they're no longer the sole focus of the library;
  2. Repurposing openssl.R to host package-level documentation;
  3. Renaming rand_pseudo_bytes to pseudo_rand_bytes to match what it does (what are pseudo-bytes? ;p)
  4. Expanding the rand_* documentation to explain the difference between rand_bytes and rand_pseudo_bytes; at the moment people have to read the OpenSSL documentation which can be kind of a slog since it's mostly designed to document the internals of their C API.
Ironholds commented 9 years ago

(obviously, each bit step by step, not all in one commit ;p)

jeroen commented 9 years ago

I doubt that a (slightly faster) reimplementation of hashing functions is a sufficient innovative contribution for a JSS paper. You have a better chance of getting it published if we make the paper more general about functionality offered by libssl and libcrypto, and how it can benefit statistical software.

jeroen commented 9 years ago

I renamed the old files: https://github.com/jeroenooms/openssl/commit/e3e1332083b0e0affa95791c8967cbe55b21c3a3. Make sure to pull so that we don't conflict :-)

Ironholds commented 9 years ago

Fair point! Thanks for the renames :).

Ironholds commented 9 years ago

initial tweaking commit. I'll close this issue for now and open more specific ones.