Re: [R] Documenting a function using roxygen2

2016-10-11 Thread Jeff Newmiller
I was under the impression that the comment block is attached to the global object that immediately follows the comment block, so this placement is NOT optional. -- Sent from my phone. Please excuse my brevity. On October 11, 2016 6:46:51 AM PDT, Thierry Onkelinx wrote: >Dear Georg, > >My 2 e

Re: [R] Documenting a function using roxygen2

2016-10-11 Thread Thierry Onkelinx
Dear Georg, My 2 eurocents. - I'd place the Roxygen header just above the function instead of instead the function. That makes your function more readable. - Use only tags that Roxygen knows about. - Use version controle instead of the version, created and updated tags. - You can specify the auth

[R] Documenting a function using roxygen2

2016-10-11 Thread G . Maubach
Hi All, I began to document my functions using roxygen2. This is an example of a function I would like to write for training and testing purposes: t_simple_table <- function(variable, useNA = TRUE, print = FALSE) { #' @title Create a simp