wyz.code.rdoc (version 1.1.19)

generateS3MethodSignature: Generate S3 method signature

Description

Function to create easily function signature from an S3 class

Usage

generateS3MethodSignature(methodName_s_1, className_s_1, argumentNames_s)

Arguments

methodName_s_1

a single string that is the function/method name to consider

className_s_1

a single string that is the class name to consider

argumentNames_s

a vector of strings that are the function/method argument names

Value

A single string.

References

Refer to Writing R extensions to know more about R documentation requirements.

Examples

# NOT RUN {
print(generateReference(
         list(url = 'https://neonira.github.io/offensiveProgrammingBook/',
             label = 'Offensive Programming Book')
))
# provides following result
# "Refer to \href{https://neonira.github.io/offensiveProgrammingBook/}{Offensive Programming Book}."
# }