get_multiple_repos_metrics {metricminer}R Documentation

Retrieve metrics for a list of repos

Description

This is a function to get metrics for a list of repos. You can provide an owner and attempt retrieve all repositories from a particular organization, or you can provide a character vector of repositories like "

Usage

get_multiple_repos_metrics(
  repo_names = NULL,
  token = NULL,
  data_format = "dataframe",
  time_course = FALSE
)

Arguments

repo_names

a character vector of repositories you'd like to collect metrics from.

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

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".

time_course

Should the time course data be collected or only the summary metrics?

Value

Information regarding a Github account

Examples

## Not run: 

authorize("github")

repo_names <- c("fhdsl/metricminer", "jhudsl/OTTR_Template")
some_repos_metrics <- get_multiple_repos_metrics(repo_names = repo_names)

some_repos_metrics <- get_multiple_repos_metrics(repo_names = repo_names, time_course = TRUE)

## End(Not run)


[Package metricminer version 0.5.1 Index]