docr.defaults: Persistent global options for the docr family

In CarlBoneri/roxydoc2: Helps document R packages properly.

Description

docr.defaults

Usage

docr.defaults(author = NULL, email = NULL, company = NULL, meta = NULL,
  website = NULL, github = NULL)

Details

In short form this is a helper to always include author, or additional params on each script skeleton. The idea is to create a global and default value emitting function stored on an options variable so that each script can include boilerplate...if desired. The settings for these options are:

author

The name of the document, package, or script author

email

The email address of the author to be included in the author title line.

company

Any company or corporate name associated with the package. This is moreso for development of proprietary packages that may be hosted or viewed by a general audience but whose contents, scripts, or algorithms may be patent-protected.

website

Any url to be included for author reference or package homepage.

github

If a github account is persistent for the package or user, This would be the username or organizational name for the package, user, author or entity that is wished to be associated with the package.

See Also

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

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