GitStats (version 2.3.3)

get_commits_stats: 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
)

Value

A table of commits_stats class.

Arguments

commits

A gitstats_commits S3 class table object (output of get_commits()).

time_aggregation

A character, specifying time aggregation of statistics.

group_var

Other grouping variable to be passed to dplyr::group_by() function apart from stats_date and githost. Could be: author, author_login, author_name or organization. Should be passed without quotation marks.

Details

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

Examples

if (FALSE) {
 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
   )
}