add_makefile: Create a Make-like R file

View source: R/add_makefile.R

add_makefileR Documentation

Create a Make-like R file

Description

This function creates a Make-like R file (make.R) at the root of the project based on a template. To be used only if the project is a research compendium. The content of this file provides some guidelines. See also new_compendium() for further information.

Usage

add_makefile(
  given = NULL,
  family = NULL,
  email = NULL,
  open = TRUE,
  overwrite = FALSE,
  quiet = FALSE
)

Arguments

given

A character of length 1. The given name of the project maintainer.

family

A character of length 1. The family name of the project maintainer.

email

A character of length 1. The email address of the project maintainer.

open

A logical value. If TRUE (default) the file is opened in the editor.

overwrite

A logical value. If this file is already present and overwrite = TRUE, it will be erased and replaced. Default is FALSE.

quiet

A logical value. If TRUE messages are deleted. Default is FALSE.

Value

No return value.

See Also

Other create files: add_citation(), add_code_of_conduct(), add_compendium(), add_contributing(), add_description(), add_dockerfile(), add_license(), add_package_doc(), add_readme_rmd(), add_renv(), add_testthat(), add_vignette()

Examples

## Not run: 
add_makefile()

## End(Not run)

rcompendium documentation built on Oct. 26, 2023, 5:08 p.m.