function_template: This function generates an R file with a roxygen2-friendly...

Description Usage Arguments Examples

View source: R/function_template.R

Description

This function generates an R file with a roxygen2-friendly template that will enable all metadata about your function to be read into the package documentation when you build your package

Usage

1
2
function_template(function_name = "my_function_template",
  dir_R = here::here("R"))

Arguments

function_name

is the name of the function you are creating

dir_R

is the directory in which you want tosave the output R file

data

is the data

x

is a variable representing something

Examples

1
2
3
4
function_template("my_function")

Say what this function does in greater detail if that helps.
my_function_template(mtcars, x = mpg)

Kidapt/keda documentation built on Oct. 15, 2019, 9:01 p.m.