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

In Kidapt/keda: A Package to Support Exploratory Data Analysis

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

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

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 Nov. 23, 2019, 3:35 a.m.