Skip to contents

Check the license of a package

Source: R/check_description.R
check_license.Rd

Every package needs a clear license. Without a license, the end-users have no clue under what conditions they can use the package. You must specify the license in the DESCRIPTION and provide a LICENSE.md file.

Usage

check_license(x = ".")

Arguments

x

Either a checklist object or a path to the source code. Defaults to ..

Details

This functions checks if the DESCRIPTION mentions one of the standard licenses. The LICENSE.md must match this license. Use setup_package() to add the correct LICENSE.md to the package.

Currently, following licenses are allowed:

  • GPL-3

  • MIT

We will consider pull requests adding support for other open source licenses.

See also

Other package: check_codemeta(), check_cran(), check_description(), check_documentation(), check_environment(), check_package(), tidy_desc()