hello_user: Greet a user

Description Usage Arguments Details Customized link text See Also Examples

View source: R/hello.R

Description

hello_user returns a personalized greeting, using the provided name argument.

Usage

1

Arguments

name

A String of any length, specifying the user that should be greeted.

Details

This function serves as an example for showing the different options for documenting functions. Here you will find most of the @tags explained in the relevant chapter of the R package book found here: http://r-pkgs.had.co.nz.

Customized link text

As a case in point the reference in the previous sentence could also have been written with customized link text, i.e. R package book. And now we have also demonstrated the use of a @section tag.

See Also

hello which is in the same @family of functions, and of course check http://r-pkgs.had.co.nz.

Other greetings: hello

Examples

1
2
3
4
5
6
7
hello_user("A")
hello_user("B")

## Not run: 
hello_user(A)

## End(Not run)

macdalmore/rpackagetest documentation built on May 25, 2019, 9:33 p.m.