add_license_file: Add License File to Project

In worcs: Workflow for Open Reproducible Code in Science

Add License File to Project

Description

This function wraps usethis' licenses functions, which are designed for R-packages. This function makes them applicable to other use cases (e.g., WORCS projects, FAIR theory).

Usage

add_license_file(path = ".", license = "ccby", ...)

Arguments

path	Character, indicating the directory in which to create the license file. Default: '.'.
license	Character, indicating which license function to call. The usethis functions all have the form ⁠use_{licensename}_license()⁠. The license argument consists only of the {licensename}, e.g. ccby.
...	Additional arguments passed to usethis function.

Value

No return value. This function is called for its side effects.

Examples

tmpdr <- file.path(tempdir(), "license")
dir.create(tmpdr)
add_license_file(path = tmpdr,
                 license = "proprietary",
                 copyright_holder = "test")
unlink(tmpdr, recursive = TRUE)

worcs documentation built on April 12, 2025, 2:23 a.m.