knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
library(pkginfo)

pkginfo

Tools for retrieving package information

CRAN_Status_Badge Travis-CI Build Status AppVeyor Build Status

Overview

pkginfo will allow users to retrieve information about a R package from CRAN, GitHub, Travis CI, Appveyor, Codecov & Stack Overflow. While it was not developed keeping any specific end user in mind, package developers might find it more useful as they can monitor their R packages using a shiny app. pkginfo uses cranlogs,crandb and cchecksapi under the hood.

Installation

You can install the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("rsquaredacademy/pkginfo")

Shiny App

Launch the shiny app with:

pkginfo_dashboard()

Usage

GitHub Info

myRepo <- GitHubRepo$new("olsrr", "rsquaredacademy")
myRepo$get_stats()
myRepo$get_issues()
myRepo$get_branches()
myRepo$get_releases()

CRAN Info

myPackage <- CranPackage$new("olsrr")
myPackage$get_version()
myPackage$get_r_dep()
myPackage$get_cran_check_results()
myPackage$get_urls()

Build Status

get_status_travis("olsrr", "rsquaredacademy")
get_status_appveyor("olsrr", "rsquaredacademy")
get_code_coverage("olsrr", "rsquaredacademy")

Stack Overflow Questions

get_so_questions("dplyr")

Community Guidelines

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.



rsquaredacademy/pkginfo documentation built on June 29, 2023, 10:48 p.m.