R/create_showcase.R

In thmshrt/writethat: Provides CRAN Valid Documentation Templates

#BEGIN: description
#' Extract examples from documentation and place in gitbook
#'
#'
#' @usage
#' create_showcase(
#'   r_dir_path = './R',
#'   gitbook_dir_path = './examples/showcase/'
#' )
#'
#' @param r_dir_path          \[character\], length 1, dir path of R file
#' @param gitbook_dir_path    \[character\], length 1, output directory
#'
#' @export
#' @importFrom magrittr %>%
#END: description
#BEGIN: examples
#' @examples
#' #BEGIN: example
#' \dontrun{
#' # simplest example
#' create_showcase()
#' }
#' #END: example
#END: examples
#BEGIN: code

create_showcase = function(
  r_dir_path = './R',
  gitbook_dir_path = './examples/showcase/'
) {

  rlang::abort('not yet implemented')
  #BEGIN: setup params

  #END: setup params

  #BEGIN: param checks

  #END: param checks

  #BEGIN: computation

  #END: computation

  #BEGIN: return

  #END: return
}

#END: code