docr.make_license: Generate a LICENSE formatted to Rd specs

In CarlBoneri/roxydoc2: Helps document R packages properly.

Description

docr.make_lic

Usage

docr.make_license(owner_name = NULL, owner_org = NULL, year = "current",
  output_to = c("file", "console"))

Arguments

owner_name	string Default to NULL Owner of the License.
owner_org	string Default to NULL If the owner attributes work to an Organization.
year	character Default to current year.
output_to	call Default to file and console Where should the output print?

Value

Output is either a LICENSE file object in the local or working directory or printed to the console

See Also

Other Documentation functions: docr.author, docr.clean_fun, docr.defaults_prompt, docr.defaults, docr.describe_df, docr.example_df, docr.family, docr.fun, docr.has_defaults, docr.install_r_only, docr.meta_private, docr.meta_public, docr.param

Examples

doc.make_lic(owner_name = 'Carl Boneri',owner_org = "FAS Advisory",
output_to = 'file')
#> #'@param owner_name string Default to NULL
#> #'@param owner_org string Default to NULL
#> #'@param year character Default to current
#> #'@param output_to call Default to file and console

CarlBoneri/roxydoc2 documentation built on Nov. 6, 2019, 8:01 a.m.