docr.author: Build an RD formatted Author line

Description Usage Details Value Author(s) See Also Examples

View source: R/docr_author.R

Description

docr.author

Usage

1
docr.author(full_name = NULL, email = NULL)

Details

Set the author line for any documentation or R scripts.

Value

The formatted roxygen line for the author.

Author(s)

Carl S.A. Boneri, carl.boneri@whyles.com

See Also

Other Documentation functions: 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.make_license, docr.meta_private, docr.meta_public, docr.param

Examples

1
2
3
4
5
6
7
me <- list(name = "Carl S.A. Boneri", email = "carl.boneri@whyles.com")
docr.author(me$name, me$email)

# The function handles improperly specified email addresses containing only
# one \code{'@'} symbol.

#' @author Carl S.A. Boneri, \email{carl.boneri@whyles.com}

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