ls_remote: Inspect directory structure of version control system...

In metrumresearchgroup/vcs: Managing, Inspecting and Sourcing Remote Repositories on a Version Control System

Description

Inspect directory structure of git/bitbuck/svn repository head

Usage

ls_remote(
  path = getwd(),
  branch = "master",
  subdir = NULL,
  vcs = "github",
  full.names = FALSE,
  PAT = Sys.getenv("GITHUB_PAT")
)

Arguments

path	character, Path to root directory of git/svn repository or a name of a github/bitbucket repository, Default: setwd()
branch	character, alias of the branch in the repository, Default: 'master'
subdir	chracter, subdirectory of repository/branch to query, if '.' then only the root directory will be queried, Default: NULL
vcs	character, choose which version control system to search (github, bitbucket, git (head of checkout repo), svn), Default: 'github'
full.names	boolean, If TRUE, the directory path is prepended to the file names to give a relative file path. If FALSE, the file names (rather than paths) are returned, Default: TRUE

Value

character

Examples

#github
  ls_remote('tidyverse/glue')
  #'named_args' branch
    ls_remote('tidyverse/glue',branch='named_args')
  #'named_args' branch only 'src' subdirectory
    ls_remote('tidyverse/glue',branch='named_args',subdir='src')
 #bitbucket
   #'master' branch
    ls_remote('metrumrg/qapply',vcs='bitbucket')

metrumresearchgroup/vcs documentation built on July 16, 2020, 8:52 p.m.