Once you have loaded the DataSHIELD packages, information about individual functions can be found on the function manual page including:
- description: what the function does
- usage: shows the syntax of the function including all arguments - this is a generalised form of how you would use the function
- arguments: of the function. These are all the things you can customise in the function
- details and values: give some additional information about the function
- examples: of how the function is run. You will be able to copy and paste these examples into R/RStudio to run yourself
You can access the help page of a function in a number of ways. To open up the function help page in a webpage:
> options(help_type="html") > help(insert_function_name)
To open up the help page within R/RStudio:
> help(insert_function_name)
an equivalent command is to use the help operator ?:
> ?(insert_function_name)
An example function help page for ds.histogram is given below.
