use_noaa_license: Document the license for a NOAA package

In nwfsc-assess/PEPtools: Tools for Stock Assessments used by the Population Ecology Program

Document the license for a NOAA package

Description

Defines the License portion of your DESCRIPTION file and prints the NOAA non-license file to the LICENSE, which is ignored in your build but available for those who wish to view it.

Usage

use_noaa_license(version = 3, include_future = TRUE)

Arguments

version	An integer specifying which GPL license you wish to use. Currently, only two or three are allowed and it defaults to three, which is the latest version as of May 2023.
include_future	A logical value. If TRUE, the result will be to license your package under the current and any potential future versions of the license. This is generally considered to be good practice because it means your package will automatically include "bug" fixes in licenses. That is, the resulting text will have a great than or equals to sign for when the license is updated.

Value

A logical vector indicating if file was modified.

Author(s)

Kelli F. Johnson

See Also

• usethis::use_gpl_license()

• https://choosealicense.com

• license chapter in R Packages.

nwfsc-assess/PEPtools documentation built on Nov. 7, 2023, 1:33 p.m.