Skip to content

Function Overview

Ábel Vértesy edited this page Feb 25, 2016 · 2 revisions

Function Overview

You find the list of function of this library below. For details, please use the help() function, or browse the source code.

1. kollapse

  • paste0 values and string to one string. It also prints the results (good for a quick check)

2. substrRight

  • Take the right substring of a string

3. toClipboard

  • Copy an R-object to your clipboard on OS X.

4. RoxygenReady

  • Read in a file, annotate and write out all functions documentation with Roxygen skeleton (FileToFile)

5. rr_extract_all_functions_from_a_script

  • Scan a script for function's defined there.

6. rr_extract_default_args

  • Get the default argument calls of a function

7. rr_extract_all_descriptions_from_comment

  • Scan a script for (descriptive) comments in the first line of each function's definition.

8. rr_extract_all_descriptions_from_comment_annot

  • Scan a script for (descriptive) comments in the 3d line of each function's Roxygen skeleton.

9. rr_function_overview_document

  • Create a Markdown document with a numbered list of all functions and their descriptions from the "inFile", saved right next to it!

10. RoxygenReady.MemoryToClipboard.singleFunction

  • Compile a single functions documentation for Roxygen

11. RoxygenReady.MemoryToFile.singleFunction

  • Compile and write out a single functions documentation for Roxygen