Getting Help With Functions In R Programming


In our previous articles we described how to install and start using R/RStudio. We also provide the essentials of R programming.


Here, we’ll describe how to get help about a specific function in R


Getting help on a specific function

To read more about a given function, for example mean, the R function help() can be used as follow:

help(mean)

Or use this:

?mean

The output look like this:

Getting help in R

If you want to see some examples of how to use the function, type this: example(function_name).

example(mean)

Note that, typical R help files contain the following sections:

  • Title
  • Description: a short description of what the function does.
  • Usage: the syntax of the function.
  • Arguments: the description of the arguments taken by the function.
  • Value: the value returned by the function
  • Examples: provide examples on how to use the function

General help

If you want to read the general documentation about R, use the function help.start():

help.start()

The output is a web page, on most R installations, which can be browsed by clicking the hyperlinks.

Getting help in R, help.start

Others

  • apropos(): returns a list of object, containing the pattern you searched, by partial matching. This is useful when you don’t remember exactly the name of the function:
# Returns the list of object containing "med"
apropos("med")
[1] ".__C__namedList" "elNamed"         "elNamed<-"       "median"          "median.default" 
[6] "medpolish"       "runmed"         
  • healp.search() (alternatively ??): Search for documentation matching a given character in different ways. It returns a list of function containing your searched term with a short description of the function.
help.search("mean")
# Or use this
??mean

Infos

This analysis has been performed using R software (ver. 3.2.3).









Want to Learn More on R Programming and Data Science?

Follow us by Email

by FeedBurner

On Social Networks:


 Get involved :
  Click to follow us on and Google+ :   
  Comment this article by clicking on "Discussion" button (top-right position of this page)
  Sign up as a member and post news and articles on STHDA web site.
This page has been seen 2056 times