vertesy / roxygenready Goto Github PK

Although I know it's not the coding standard, I use = for assignment in R, and this includes function defintion. I see that rr_extract_all_functions_from_a_script is grepping as follows:
patt = " *<- *function *\\(.+"
index = grep(patt, ScriptAsStringsPerLine, perl = T)

This results in RoxygenReady not detecting any functions in my script.

This is a useful premise for a package. Running on a sample script I find:

Error in rr_extract_default_args(funnames[i]) :
could not find function "as.named.vector"

Looking in another repo I see: https://github.com/vertesy/TheCorvinas/blob/master/R/CodeAndRoll.R#L186

as.named.vector <- function(df_col, WhichDimNames = 1) { # Convert a dataframe column or row into a vector, keeping the corresponding dimension name.
    # use RowNames: WhichDimNames = 1 , 2: use ColNames
    # !!! might require drop=F in subsetting!!! eg: df_col[,3, drop=F]
    # df_col[which(unlist(lapply(df_col, is.null)))] = "NULL" # replace NULLs - they would fall out of vectors - DOES not work yet
    namez = dimnames(df_col)[[WhichDimNames]]
    if (is.list(df_col) & !is.data.frame(df_col)) {namez = names(df_col)}
    vecc = as.vector(unlist (df_col))
    names (vecc)= namez
    return (vecc)
}

Sourcing the above function allows the code to run without error.

& Learn about package testing...

• Take the functions from CodeAndRoll

First line comment is parsed to the description field of the roxygen-ready annotation (3rd line)

1. Bugs
   • The header line and
   • the @example and
   • the Description lines are incorrect !

instead of

   #' RoxygenReady.MemoryToClipboard 

it should be:

   #' Your functions

• ### missing feature: It should also parse the function's body to the clipboard

fct(dir = "/path/to/file", ...)

becomes

#' @examples fct(dir = /path/to/file, ...)

Neither in RoxygenReady(), nor in rr_ ... overview function..

Do it at the very end, it will be overwritten every time you load Readme.md

change the following links

• view on github
• maintained by
• edit the website?

edit:

   subl /Users/abelvertesy/roxygenready.github.io/index.html

Constantly getting Error in FUN(X[[i]], ...) : object ' FUN' not found in almost all files.

• Add a header, "Created by RR",
• Search Stack overflow / Set up an alert for keyword
• Webpage: Install and usage / workflow explained,
• Webpage: "from" missing
• Release 1.0.1

Refer to RStudio's single function feature

https://stackoverflow.com/questions/10825058/can-rstudio-automatically-generate-an-roxygen-template-for-a-function?rq=1

Also refer to

https://cran.r-project.org/web/packages/roxygen2/vignettes/rd.html

in rr_extract_all_functions_from_a_script the regex needs to be:
patt = " *(<-|=) *function *\\(.+"
instead of:
patt = " *<-|= *function *\\(.+"

or you will grep other (non-function) lines.