camr_document_function: Create a Template for a Function's Documentation

In rettopnivek/camrprojects: Portable Functions for R Projects at CAM-MGH

Create a Template for a Function's Documentation

Description

Given an R script that contains a function whose name and arguments follow a specific naming convention, generates a template for the function documentation (determining dependencies on R packages, target outputs, and other project functions).

Usage

camr_document_function(
  func_name,
  tag_for_proj_fun = NULL,
  script_path = NULL,
  folder_with_scripts = "R"
)

Arguments

func_name	A character string, the name of the function for which a template of the documentation is needed.
tag_for_proj_fun	A character string, the substring that precedes every project function. For example, if project functions follow the format project.RXX.function_name the input should be project.R.
script_path	A character string, the path to the R script containing the function (relative to the working directory).

Value

A message displayed in the console with the template for the function documentation, which can be copied and pasted as needed.

rettopnivek/camrprojects documentation built on March 26, 2024, 9:17 a.m.