write_links_for_website: Write links for website

In readyforwhatsnext/ready4fun: ready4 Function Authoring And Documentation Tools

Description

write_links_for_website() is a Write function that writes a file to a specified local directory. Specifically, this function implements an algorithm to write links for website. The function is called for its side effects and does not return a value. WARNING: This function writes R scripts to your local environment. Make sure to only use if you want this behaviour

Usage

write_links_for_website(
  path_to_pkg_rt_1L_chr = getwd(),
  user_manual_url_1L_chr,
  developer_manual_url_1L_chr,
  project_website_url_1L_chr = "https://readyforwhatsnext.github.io/readyforwhatsnext/"
)

Arguments

path_to_pkg_rt_1L_chr	Path to package root (a character vector of length one), Default: getwd()
user_manual_url_1L_chr	User manual url (a character vector of length one)
developer_manual_url_1L_chr	Developer manual url (a character vector of length one)
project_website_url_1L_chr	Project website url (a character vector of length one), Default: 'https://readyforwhatsnext.github.io/readyforwhatsnext/'

readyforwhatsnext/ready4fun documentation built on Nov. 22, 2020, 9:28 p.m.