add_license: Add a LICENSE

Description Usage Arguments Value See Also Examples

View source: R/add_license.R

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

1
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

None

See Also

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

Examples

1
2
3
4
5
## Not run: 
add_license(license = "MIT")
add_license(license = "GPL (>= 2)")

## End(Not run)

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