get_github_repo_summary {metricminer}

Collect repository summary metrics

Description

This is a wrapper for get_github_metrics that has 'time_course = FALSE' so that summary metrics are collected

This is a function to get the information about a repository

Usage

get_github_repo_summary(
  repo,
  token = NULL,
  count = "all",
  data_format = "dataframe"
)

Arguments

repo

The repository name. So for 'https://github.com/fhdsl/metricminer', it would be 'fhdsl/metricminer'

token

You can provide the Personal Access Token key directly or this function will attempt to grab a PAT that was stored using the 'authorize("github")' function

count

How many items would you like to receive? Put "all" to retrieve all records.

data_format

Default is to return a curated data frame. However if you'd like to see the raw information returned from GitHub set format to "raw".

Value

GitHub repository summary metrics

Examples

## Not run: 

authorize("github")

summary_metrics <- get_github_repo_summary(repo = "fhdsl/metricminer")

## End(Not run)