Create a GitStats object

Description

Create a GitStats object

Usage

create_gitstats()

Value

A GitStats object.

Examples

my_gitstats <- create_gitstats()

Get data on commits

Description

List all commits from all repositories for an organization or a vector of repositories.

Usage

get_commits(
  gitstats,
  since = NULL,
  until = Sys.Date(),
  cache = TRUE,
  verbose = FALSE,
  progress = TRUE
)

Arguments

Value

A table of tibble and gitstats_commits classes.

Examples

## Not run: 
my_gitstats <- create_gitstats() |>
  set_github_host(
    token = Sys.getenv("GITHUB_PAT"),
    repos = c("openpharma/DataFakeR", "openpharma/visR")
  ) |>
  set_gitlab_host(
    token = Sys.getenv("GITLAB_PAT_PUBLIC"),
    orgs = "mbtests"
  )
 get_commits(my_gitstats, since = "2018-01-01")

## End(Not run)

Get commits statistics

Description

Prepare statistics from the pulled commits data.

Usage

get_commits_stats(
  commits,
  time_aggregation = c("year", "month", "week", "day"),
  group_var
)

Arguments

Details

To make function work, you need first to get commits data with GitStats. See examples section.

Value

A table of commits_stats class.

Examples

## Not run: 
 my_gitstats <- create_gitstats() |>
   set_github_host(
     token = Sys.getenv("GITHUB_PAT"),
     repos = c("r-world-devs/GitStats", "openpharma/visR")
   ) |>
   get_commits(my_gitstats, since = "2022-01-01") |>
   get_commits_stats(
     time_aggregation = "year",
     group_var = author
   )

## End(Not run)

Get files

Description

Pulls text files and their content.

Usage

get_files(
  gitstats,
  pattern = NULL,
  depth = Inf,
  file_path = NULL,
  cache = TRUE,
  verbose = FALSE,
  progress = TRUE
)

Arguments

Details

get_files() may be used in two ways: either with pattern (with optional depth) or file_path argument defined.

In the first scenario, GitStats will pull first a files structure responding to the passed pattern and depth arguments and afterwards files content for all of these files. In the second scenario, GitStats will pull only the content of files for the specific file_path of the repository.

If user wants to pull a particular file or files, a file_path approach seems more reasonable, as it is a faster way since it omits pulling the whole file structure from the repo.

For example, if user wants to pull content of README.md and/or NEWS.md files placed in the root directories of the repositories, he should take the file_path approach as he already knows precisely paths of the files.

On the other hand, if user wants to pull specific type of files (e.g. all .md or .Rmd files in the repository), without knowing their path, it is recommended to use a pattern approach, which will trigger GitStats to find all the files in the repository on the given level of directories (pattern argument) and afterwards pull their content.

The latter approach is slower than the former but may be more useful depending on users' goals. Both approaches return data in the same format: tibble with data on files, namely their path and their content.

Value

A data.frame.

Examples

## Not run: 
 git_stats <- create_gitstats() |>
  set_github_host(
    token = Sys.getenv("GITHUB_PAT"),
    orgs = c("r-world-devs")
  ) |>
  set_gitlab_host(
    token = Sys.getenv("GITLAB_PAT_PUBLIC"),
    orgs = "mbtests"
  )

 rmd_files <- get_files(
   gitstats = git_stats,
   pattern = "\\.Rmd",
   depth = 2L
 )

 app_files <- get_files(
   gitstats = git_stats,
   file_path = c("R/app.R", "R/ui.R", "R/server.R")
 )


## End(Not run)

Get data on issues

Description

List all issues from all repositories for an organization or a vector of repositories.

Usage

get_issues(
  gitstats,
  since = NULL,
  until = Sys.Date(),
  state = NULL,
  cache = TRUE,
  verbose = FALSE,
  progress = TRUE
)

Arguments

Value

A table of tibble and gitstats_issues classes.

Examples

## Not run: 
my_gitstats <- create_gitstats() |>
  set_github_host(
    token = Sys.getenv("GITHUB_PAT"),
    repos = c("openpharma/DataFakeR", "openpharma/visR")
  ) |>
  set_gitlab_host(
    token = Sys.getenv("GITLAB_PAT_PUBLIC"),
    orgs = "mbtests"
  )
 get_issues(my_gitstats, since = "2018-01-01", state = "open")

## End(Not run)

Get issues statistics

Description

Prepare statistics from the pulled issues data.

Usage

get_issues_stats(
  issues,
  time_aggregation = c("year", "month", "week", "day"),
  group_var
)

Arguments

Details

To make function work, you need first to get issues data with GitStats. See examples section.

Value

A table of issues_stats class.

Examples

## Not run: 
 my_gitstats <- create_gitstats() |>
   set_github_host(
     token = Sys.getenv("GITHUB_PAT"),
     repos = c("r-world-devs/GitStats", "openpharma/visR")
   ) |>
   get_issues(my_gitstats, since = "2022-01-01") |>
   get_issues_stats(
     time_aggregation = "month",
     group_var = state
   )

## End(Not run)

Get data on organizations

Description

Pulls data on all organizations from a Git host and parses it into table format.

Usage

get_orgs(gitstats, cache = TRUE, verbose = FALSE)

Arguments

Value

A data.frame.

Examples

## Not run: 
my_gitstats <- create_gitstats() |>
  set_github_host(
    orgs = c("r-world-devs", "openpharma"),
    token = Sys.getenv("GITHUB_PAT")
  ) |>
  set_gitlab_host(
    orgs = "mbtests",
    token = Sys.getenv("GITLAB_PAT_PUBLIC")
  )
get_orgs(my_gitstats)

## End(Not run)

Get data on pull requests

Description

List all pull requests from all repositories for an organization or a vector of repositories.

Usage

get_pull_requests(
  gitstats,
  since = NULL,
  until = Sys.Date(),
  state = NULL,
  cache = TRUE,
  verbose = FALSE,
  progress = TRUE
)

Arguments

Value

A table of tibble and gitstats_pull_requests classes.

Examples

## Not run: 
my_gitstats <- create_gitstats() |>
  set_github_host(
    token = Sys.getenv("GITHUB_PAT"),
    repos = c("openpharma/DataFakeR", "openpharma/visR")
  ) |>
  set_gitlab_host(
    token = Sys.getenv("GITLAB_PAT_PUBLIC"),
    orgs = "mbtests"
  )
 get_pull_requests(my_gitstats, since = "2018-01-01", state = "open")

## End(Not run)

Get pull requests statistics

Description

Prepare statistics from the pulled pull requests data.

Usage

get_pull_requests_stats(
  pull_requests,
  time_aggregation = c("year", "month", "week", "day"),
  group_var
)

Arguments

Details

To make function work, you need first to get pull requests data with GitStats. See examples section.

Value

A table of pull_requests_stats class.

Examples

## Not run: 
 my_gitstats <- create_gitstats() |>
   set_github_host(
     token = Sys.getenv("GITHUB_PAT"),
     repos = c("r-world-devs/GitStats", "openpharma/visR")
   ) |>
   get_pull_requests(my_gitstats, since = "2022-01-01") |>
   get_pull_requests_stats(
     time_aggregation = "month",
     group_var = author
   )

## End(Not run)

Get release logs

Description

Pull release logs from repositories.

Usage

get_release_logs(
  gitstats,
  since = NULL,
  until = Sys.Date(),
  cache = TRUE,
  verbose = FALSE,
  progress = TRUE
)

Arguments

Value

A data.frame.

Examples

## Not run: 
 my_gitstats <- create_gitstats() |>
  set_github_host(
    token = Sys.getenv("GITHUB_PAT"),
    orgs = c("r-world-devs", "openpharma")
  )
  get_release_logs(my_gistats, since = "2024-01-01")

## End(Not run)

Get data on repositories

Description

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,
  add_contributors = TRUE,
  add_languages = TRUE,
  with_code = NULL,
  in_files = NULL,
  with_files = NULL,
  language = NULL,
  cache = TRUE,
  verbose = FALSE,
  progress = TRUE,
  fill_empty_sha = FALSE
)

Arguments

Value

A data.frame.

Examples

## Not run: 
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, add_languages = FALSE)
get_repos(my_gitstats, with_code = "Shiny", in_files = "renv.lock")
get_repos(my_gitstats, with_files = "DESCRIPTION")

## End(Not run)

Get data on files trees across repositories

Description

Pulls files tree (structure) per repository. Files trees are then stored as character vectors in files_tree column of output table.

Usage

get_repos_trees(
  gitstats,
  pattern = NULL,
  depth = Inf,
  cache = TRUE,
  verbose = FALSE,
  progress = TRUE
)

Arguments

Value

A tibble.

Examples

## Not run: 
 my_gitstats <- create_gitstats() |>
  set_github_host(
    token = Sys.getenv("GITHUB_PAT"),
    orgs = c("r-world-devs", "openpharma")
  )

 get_repos_trees(
   gitstats = my_gitstats,
   pattern = "\\.md"
 )

## End(Not run)

Get repository URLS

Description

Pulls a vector of repositories URLs (web or API): either all for an organization or those with a given text in code blobs (with_code parameter) or a file (with_files parameter).

Usage

get_repos_urls(
  gitstats,
  type = "api",
  with_code = NULL,
  in_files = NULL,
  with_files = NULL,
  cache = TRUE,
  verbose = FALSE,
  progress = TRUE
)

Arguments

Value

A character vector.

Examples

## Not run: 
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_urls(my_gitstats, with_files = c("DESCRIPTION", "LICENSE"))

## End(Not run)

Get data from GitStats storage

Description

Retrieves whole or particular data (see storage parameter) pulled earlier with GitStats.

Usage

get_storage(gitstats, storage = NULL)

Arguments

Value

A list of tibbles (if storage set to NULL) or a tibble (if storage defined).

Examples

## Not run: 
 my_gitstats <- create_gitstats() |>
  set_github_host(
    token = Sys.getenv("GITHUB_PAT"),
    orgs = c("r-world-devs", "openpharma")
  )
  get_release_logs(my_gistats, since = "2024-01-01")
  get_repos(my_gitstats)

  release_logs <- get_storage(
    gitstats = my_gitstats,
    storage = "release_logs"
  )

## End(Not run)

Get metadata for a storage table

Description

Retrieves metadata (R classes, custom attributes, column types) for a table stored in the active storage backend.

Usage

get_storage_metadata(gitstats, storage = NULL)

Arguments

Value

A list with metadata fields: class, attributes, and (for database backends) column_types.

Examples

## Not run: 
  my_gitstats <- create_gitstats() |>
    set_github_host(
      token = Sys.getenv("GITHUB_PAT"),
      orgs = "r-world-devs"
    )
  get_commits(my_gitstats, since = "2024-01-01")
  get_storage_metadata(my_gitstats, storage = "commits")

## End(Not run)

Get users data

Description

Get users data

Usage

get_users(gitstats, logins, cache = TRUE, verbose = FALSE)

Arguments

Value

A data.frame.

Examples

## Not run: 
 my_gitstats <- create_gitstats() |>
  set_github_host(
    token = Sys.getenv("GITHUB_PAT"),
    orgs = c("r-world-devs")
  ) |>
  set_gitlab_host(
    token = Sys.getenv("GITLAB_PAT_PUBLIC"),
    orgs = "mbtests"
  )
 get_users(my_gitstats, c("maciekabanas", "marcinkowskak"))

## End(Not run)

Is verbose mode switched on

Description

Is verbose mode switched on

Usage

is_verbose(gitstats)

Arguments

Remove a table from GitStats storage

Description

Removes a named table from the active storage backend.

Usage

remove_from_storage(gitstats, storage)

Arguments

Value

A GitStats object (invisibly).

Examples

## Not run: 
  my_gitstats <- create_gitstats() |>
    set_github_host(
      token = Sys.getenv("GITHUB_PAT"),
      orgs = "r-world-devs"
    )
  get_commits(my_gitstats, since = "2024-01-01")
  remove_from_storage(my_gitstats, storage = "commits")

## End(Not run)

Remove PostgreSQL storage

Description

Drops the GitStats schema (with all tables and metadata) from the PostgreSQL database, closes the connection, and reverts storage to the default in-memory local backend. Errors if no PostgreSQL backend is currently set.

Usage

remove_postgres_storage(gitstats)

Arguments

Value

A GitStats object (invisibly).

Examples

## Not run: 
  my_gitstats <- create_gitstats() |>
    set_postgres_storage(
      dbname = "my_database",
      host = "localhost",
      user = "postgres",
      password = "secret"
    )
  remove_postgres_storage(my_gitstats)

## End(Not run)

Remove SQLite storage

Description

Closes the SQLite connection and, for file-based databases, deletes the database file. For in-memory databases the data is simply discarded. Storage is reverted to the default in-memory local backend. Errors if no SQLite backend is currently set.

Usage

remove_sqlite_storage(gitstats)

Arguments

Value

A GitStats object (invisibly).

Examples

## Not run: 
  my_gitstats <- create_gitstats() |>
    set_sqlite_storage(dbname = "gitstats.sqlite")
  remove_sqlite_storage(my_gitstats)

## End(Not run)

Set GitHub host

Description

Set GitHub host

Usage

set_github_host(
  gitstats,
  host = NULL,
  token = NULL,
  orgs = NULL,
  repos = NULL,
  verbose = is_verbose(gitstats),
  .error = TRUE
)

Arguments

Details

If you do not define orgs and repos, GitStats will be set to scan whole Git platform (such as enterprise version of GitHub or GitLab), unless it is a public platform. In case of a public one (like GitHub) you need to define orgs or repos as scanning through all organizations may take large amount of time.

Value

A GitStats object with added information on host.

Examples

## Not run: 
my_gitstats <- create_gitstats() |>
  set_github_host(
    orgs = c("r-world-devs", "openpharma", "pharmaverse")
  )

## End(Not run)

Set GitLab host

Description

Set GitLab host

Usage

set_gitlab_host(
  gitstats,
  host = NULL,
  token = NULL,
  orgs = NULL,
  repos = NULL,
  verbose = is_verbose(gitstats),
  .error = TRUE
)

Arguments

Details

If you do not define orgs and repos, GitStats will be set to scan whole Git platform (such as enterprise version of GitHub or GitLab), unless it is a public platform. In case of a public one (like GitHub) you need to define orgs or repos as scanning through all organizations may take large amount of time.

Value

A GitStats object with added information on host.

Examples

## Not run: 
my_gitstats <- create_gitstats() |>
  set_gitlab_host(
    token = Sys.getenv("GITLAB_PAT_PUBLIC"),
    orgs = "mbtests"
  )

## End(Not run)

Set local (in-memory) storage

Description

Reset storage to the default in-memory backend.

Usage

set_local_storage(gitstats)

Arguments

Value

A GitStats object (invisibly).

Examples

## Not run: 
  my_gitstats <- create_gitstats() |>
    set_local_storage()

## End(Not run)

Enable parallel processing

Description

Set up parallel processing for API calls using mirai daemons. When enabled, GitStats fetches data from multiple repositories concurrently. Call set_parallel(FALSE) or set_parallel(0) to revert to sequential execution.

Usage

set_parallel(workers = TRUE)

Arguments

Value

Invisibly returns the status from mirai::daemons().

Examples

## Not run: 
  my_gitstats <- create_gitstats() |>
    set_github_host(
      token = Sys.getenv("GITHUB_PAT"),
      orgs = c("r-world-devs", "openpharma")
    )
  set_parallel(4)
  get_commits(my_gitstats, since = "2024-01-01")
  set_parallel(FALSE) # revert to sequential

## End(Not run)

Set PostgreSQL storage

Description

Persist GitStats data in a PostgreSQL database. R classes, custom attributes, and column types are preserved via a ⁠_metadata⁠ table. Requires DBI, RPostgres, and jsonlite packages.

Usage

set_postgres_storage(
  gitstats,
  host = NULL,
  port = NULL,
  dbname = NULL,
  user = NULL,
  password = NULL,
  schema = "git_stats",
  ...
)

Arguments

Value

A GitStats object (invisibly).

Examples

## Not run: 
  my_gitstats <- create_gitstats() |>
    set_postgres_storage(
      dbname = "my_database",
      host = "localhost",
      user = "postgres",
      password = "secret"
    )

## End(Not run)

Set SQLite storage

Description

Persist GitStats data in a SQLite database. R classes, custom attributes, and column types are preserved via a ⁠_metadata⁠ table. Requires DBI, RSQLite, and jsonlite packages.

Usage

set_sqlite_storage(gitstats, dbname = ":memory:")

Arguments

Value

A GitStats object (invisibly).

Examples

## Not run: 
  # File-based
  my_gitstats <- create_gitstats() |>
    set_sqlite_storage(dbname = "gitstats.sqlite")

  # In-memory
  my_gitstats <- create_gitstats() |>
    set_sqlite_storage()

## End(Not run)

Show hosts set in GitStats

Description

Retrieves hosts set by GitStats with ⁠set_*_host()⁠ functions.

Usage

show_hosts(gitstats)

Arguments

Value

A list of hosts.

Show organizations set in GitStats

Description

Retrieves organizations set or pulled by GitStats. Especially helpful when user is scanning whole git platform and wants to have a glimpse at organizations.

Usage

show_orgs(gitstats)

Arguments

Value

A vector of organizations.

Switch off verbose mode

Description

Stop printing messages and output.

Usage

verbose_off(gitstats)

Arguments

Value

A GitStats object.

Switch on verbose mode

Description

Print all messages and output.

Usage

verbose_on(gitstats)

Arguments

Value

A GitStats object.