RH-template-package: Robot helper template

In BabyMouse/Rb3m: Rb3m package

Description

A robot helper template for roxygen2.

Add some features

A robot helper template for roxygen2.

Usage

add_numbers(x)
add_numbers(x, y)

Arguments

x	A description of the parameter 'x'. The description can span multiple lines.
y	A description of the parameter 'y'.

Details

Details for some things.

Value

Return or output of function add_numbers.

A Custom Section

Text accompanying the custom section.

Note

1. Note 1.

2. Note 2.

Author(s)

Trát Quang Thụy

Source

• https://cran.r-project.org/web/packages/roxygen2/vignettes/rd.html

References

label-1

text-1

label-2

text-2

See Also

• GitHub: https://github.com/BabyMouse/Rb3m

• http://r-pkgs.had.co.nz/man.html

Examples

add_numbers(1, 2) ## returns 3

## don't run this in calls to 'example(add_numbers)'
## Not run: 
   add_numbers(2, 3)

## End(Not run)

## don't test this during 'R CMD check'

   add_numbers(4, 5)

BabyMouse/Rb3m documentation built on June 4, 2020, 11:21 a.m.