add_license: Add a LICENSE

In rcompendium: Create a Package or Research Compendium Structure

Add a LICENSE

Description

This function adds a license to the project. It will add the license name in the License field of the DESCRIPTION file and write the content of the license in the License.md file.

Usage

add_license(license = NULL, given = NULL, family = NULL, quiet = FALSE)

Arguments

license	A character of length 1. The chosen license. Run get_licenses()) to select an appropriate one.
given	A character of length 1. The given name of the copyright holder. Only required if license = 'MIT'. If is NULL (default) and license = 'MIT', this function will try to retrieve the value of this parameter from the .Rprofile file (edited with set_credentials()).
family	A character of length 1. The family name of the copyright holder. Only required if license = 'MIT'. If is NULL (default) and license = 'MIT', this function will try to retrieve the value of this parameter from the .Rprofile file (edited with set_credentials()).
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_makefile(), add_package_doc(), add_readme_rmd(), add_renv(), add_testthat(), add_vignette()

Examples

## Not run: 
add_license(license = "MIT")
add_license(license = "GPL (>= 2)")

## End(Not run)

rcompendium documentation built on Sept. 9, 2025, 5:29 p.m.