docr.make_license: Generate a LICENSE formatted to Rd specs

Description Usage Arguments Value See Also Examples

View source: R/utils_docr.R View source: R/docr_make_license.R

Description

docr.make_lic

docr.make_lic

Usage

1
2
3
4
5
docr.make_license(owner_name = NULL, owner_org = NULL, year = "current",
  output_to = c("file", "console"))

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?

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

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.meta_private, docr.meta_public, docr.param, ds.name, pound

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.meta_private, docr.meta_public, docr.param, ds.name, pound

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
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



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/taskr documentation built on June 1, 2017, 11:02 p.m.