add_makefile: Create a Make-like R file

Description Usage Arguments Value See Also Examples

View source: R/add_makefile.R

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

1
2
3
4
5
6
7
8
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 package maintainer.

family

a character of length 1

The family name of the package maintainer.

email

a character of length 1

The email address of the package 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

None

See Also

Other create files: add_citation(), add_compendium(), add_description(), add_license(), add_package_doc(), add_readme_rmd(), add_testthat(), add_vignette()

Examples

1
2
3
4
## Not run: 
add_makefile()

## End(Not run)

rcompendium documentation built on March 24, 2021, 5:06 p.m.