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).


Enjoyed this article? I’d be very grateful if you’d help it spread by emailing it to a friend, or sharing it on Twitter, Facebook or Linked In.

Show me some love with the like buttons below... Thank you and please don't forget to share and comment below!!
Avez vous aimé cet article? Je vous serais très reconnaissant si vous aidiez à sa diffusion en l'envoyant par courriel à un ami ou en le partageant sur Twitter, Facebook ou Linked In.

Montrez-moi un peu d'amour avec les like ci-dessous ... Merci et n'oubliez pas, s'il vous plaît, de partager et de commenter ci-dessous!





This page has been seen 72854 times