R/ZoonModuleParse.R

In Boodogs/zoon-clone: Reproducible, Accessible & Shareable Species Distribution Modelling

#' Parse a module file to read roxygen tags
#'
#' This is a stand in for the parse_file function in roxygen which
#' is not exported.
#' 
#' @param modulePath The path to a zoon module .R script
#'
#' @return Named list of roxygen tags
#' @name ZoonModuleParse
#' @export
#' @import roxygen2


ZoonModuleParse <- function(modulePath){
  
  # Read in the file
  lines <- readLines(modulePath, -1)
  
  # Get the tags out
  roc <- roxygen2::rd_roclet()
  rd <- roxygen2::roc_proc_text(roc, lines)[[1]]
  res <- lapply(names(rd),
                function(field, x) x[[1]][[field]]$values,
                rd)
  
  # flatten 'sections'
  if('section' %in% names(res)){
    
    sections <- lapply(res$section,
                       function(x) paste0(x$name, ':', x$content))
    
    # name sections
    names(sections) <- rep('section', length(sections))
    
    # replace old section with new sections
    res[['section']] <- NULL
    res <- append(res, sections)
    
  }
  
  #format params
  if('param' %in% names (res)){
    
    params <- lapply(names(res$param),
                     function(field, x) list(name = field,
                                             description = as.character(x[field])),
                     res$param)
    
    names(params) <-  rep('param', length(params))
    res[['param']] <- NULL
    res <- append(params, res)
    
  }
  
  return(res)
  
}