PaRe (version 0.1.16)

getDefinedFunctions: getDefinedFunctions

Description

Gets all the defined functions from a Repository object.

Usage

getDefinedFunctions(repo)

Value

(data.frame)

column	data type
name	character
lineStart	integer
lineEnd	numeric
nArgs	integer
cycloComp	integer
fileName	character

Arguments

repo

(Repository)
Repository object.

Examples

fetchedRepo <- tryCatch(
  {
    # Set dir to clone repository to.
    tempDir <- tempdir()
    pathToRepo <- file.path(tempDir, "glue")

    # Clone repo
    git2r::clone(
      url = "https://github.com/tidyverse/glue.git",
      local_path = pathToRepo
    )

    # Create instance of Repository object.
    repo <- PaRe::Repository$new(path = pathToRepo)

    # Set fetchedRepo to TRUE if all goes well.
    TRUE
  },
  error = function(e) {
    # Set fetchedRepo to FALSE if an error is encountered.
    FALSE
  },
  warning = function(w) {
    # Set fetchedRepo to FALSE if a warning is encountered.
    FALSE
  }
)

if (fetchedRepo) {
  repo <- PaRe::Repository$new(pathToRepo)

  getDefinedFunctions(repo)
}