golem (version 0.5.1)

add_fct: Add fct_ and utils_ files

Description

These functions add files in the R/ folder that starts either with fct_ (short for function) or with utils_.

Usage

add_fct(
  name,
  module = NULL,
  pkg = get_golem_wd(),
  open = TRUE,
  dir_create = TRUE,
  with_test = FALSE
)
add_utils(
  name,
  module = NULL,
  pkg = get_golem_wd(),
  open = TRUE,
  dir_create = TRUE,
  with_test = FALSE
)
add_r6(
  name,
  module = NULL,
  pkg = get_golem_wd(),
  open = TRUE,
  dir_create = TRUE,
  with_test = FALSE
)

Value

The path to the file, invisibly.

Arguments

name

The name of the file

module

If not NULL, the file will be module specific in the naming (you don't need to add the leading mod_).

pkg

Path to the root of the package. Default is get_golem_wd().

open

Should the created file be opened?

dir_create

Creates the directory if it doesn't exist, default is TRUE.

with_test

should the module be created with tests?