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

Description Usage Arguments Value Examples

View source: R/ls_remote.R

Description

Inspect directory structure of git/bitbuck/svn repository head

Usage

1
2
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

1
2
3
4
5
6
7
8
9
#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 21, 2018, 6:17 a.m.