GitHub-API: GitHub API

In Luminescence: Comprehensive Luminescence Dating Data Analysis

GitHub API

Description

R Interface to the GitHub API v3.

Usage

github_commits(user = "r-lum", repo = "luminescence", branch = "master", n = 5)

github_branches(user = "r-lum", repo = "luminescence")

github_issues(user = "r-lum", repo = "luminescence", verbose = TRUE)

Arguments

user	character (with default): GitHub user name (defaults to 'r-lum').
repo	character (with default): name of a GitHub repository (defaults to 'luminescence').
branch	character (with default): branch of a GitHub repository (defaults to 'master').
n	integer (with default): number of commits returned (defaults to 5).
verbose	logical (with default): print the output to the console (defaults to TRUE).

Details

These functions can be used to query a specific repository hosted on GitHub.

github_commits lists the most recent n commits of a specific branch of a repository.

github_branches can be used to list all current branches of a repository and returns the corresponding SHA hash as well as an installation command to install the branch in R via the 'devtools' package.

github_issues lists all open issues for a repository in valid YAML.

Value

github_commits: data.frame with columns:

⁠[ ,1]⁠	SHA
⁠[ ,2]⁠	AUTHOR
⁠[ ,3]⁠	DATE
⁠[ ,4]⁠	MESSAGE

github_branches: data.frame with columns:

⁠[ ,1]⁠	BRANCH
⁠[ ,2]⁠	SHA
⁠[ ,3]⁠	INSTALL

github_commits: Nested list with n elements. Each commit element is a list with elements:

⁠[[1]]⁠	NUMBER
⁠[[2]]⁠	TITLE
⁠[[3]]⁠	BODY
⁠[[4]]⁠	CREATED
⁠[[5]]⁠	UPDATED
⁠[[6]]⁠	CREATOR
⁠[[7]]⁠	URL
⁠[[8]]⁠	STATUS

Function version

0.1.0

How to cite

Burow, C., 2024. GitHub-API(): GitHub API. Function version 0.1.0. In: Kreutzer, S., Burow, C., Dietze, M., Fuchs, M.C., Schmidt, C., Fischer, M., Friedrich, J., Mercier, N., Philippe, A., Riedesel, S., Autzen, M., Mittelstrass, D., Gray, H.J., Galharret, J., 2024. Luminescence: Comprehensive Luminescence Dating Data Analysis. R package version 0.9.24. https://CRAN.R-project.org/package=Luminescence

Author(s)

Christoph Burow, University of Cologne (Germany) , RLum Developer Team

References

GitHub Developer API v3. https://docs.github.com/v3/, last accessed: 10/01/2017.

Examples

## Not run: 
github_branches(user = "r-lum", repo = "luminescence")
github_issues(user = "r-lum", repo = "luminescence")
github_commits(user = "r-lum", repo = "luminescence", branch = "master", n = 10)

## End(Not run)

Luminescence documentation built on June 22, 2024, 9:54 a.m.