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.

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.

Examples

if (FALSE) {
add_license(license = "MIT")
add_license(license = "GPL (>= 2)")
}