Pulls data on all repositories for an organization, individual
user or those with a given text in code blobs (with_code
parameter) or a
file (with_files
parameter) and parse it into table format.
Usage
get_repos(
gitstats_object,
add_contributors = TRUE,
with_code = NULL,
in_files = NULL,
with_files = NULL,
cache = TRUE,
verbose = is_verbose(gitstats_object),
progress = verbose
)
Arguments
- gitstats_object
A GitStats object.
- add_contributors
A logical parameter to decide whether to add information about repositories' contributors to the repositories output (table). If set to
FALSE
it makes function run faster as, in the case oforg
search mode, it reaches onlyGraphQL
endpoint with a query on repositories, and in the case ofcode
search mode it reaches onlyrepositories REST API
endpoint. However, the pitfall is that the result does not convey information on contributors.
When set toTRUE
(by default),GitStats
iterates additionally over pulled repositories and reaches to thecontributors APIs
, which makes it slower, but gives additional information.- with_code
A character vector, if defined, GitStats will pull repositories with specified code phrases in code blobs.
- in_files
A character vector of file names. Works when
with_code
is set - then it searches code blobs only in files passed toin_files
parameter.- with_files
A character vector, if defined, GitStats will pull repositories with specified files.
- cache
A logical, if set to
TRUE
GitStats will retrieve the last result from its storage.- verbose
A logical,
TRUE
by default. IfFALSE
messages and printing output is switched off.- progress
A logical, by default set to
verbose
value. IfFALSE
nocli
progress bar will be displayed.
Examples
if (FALSE) { # \dontrun{
my_gitstats <- create_gitstats() %>%
set_github_host(
token = Sys.getenv("GITHUB_PAT"),
orgs = c("r-world-devs", "openpharma")
) %>%
set_gitlab_host(
token = Sys.getenv("GITLAB_PAT_PUBLIC"),
orgs = "mbtests"
)
get_repos(my_gitstats)
get_repos(my_gitstats, add_contributors = FALSE)
get_repos(my_gitstats, with_code = "Shiny", in_files = "renv.lock")
get_repos(my_gitstats, with_files = "DESCRIPTION")
} # }