An open API service indexing awesome lists of open source software.

https://github.com/yonicd/craninfo

sessioninfo with cran check information
https://github.com/yonicd/craninfo

Last synced: about 1 month ago
JSON representation

sessioninfo with cran check information

Awesome Lists containing this project

README

        

---
output: github_document
---

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```

# craninfo

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)

The goal of `checkinfo` is to surface `CRAN` checks information into a [sessioninfo](https://github.com/r-lib/sessioninfo) output specific to the user's platform.

## Installation

``` r
# install.packages("remotes")
remotes::install_github("yonicd/craninfo")
```
## Example

This is a basic example which shows you how to solve a common problem:

```{r example}
library(craninfo)
```

On CRAN each package is continually checked to see if there are any problems with it on a variety of platforms and this information is always available for package users to view.

[cchecks](https://github.com/ropenscilabs/cchecks) is an R package that uses an API to retrieve information from these tests in an efficient manner.

Here is the output from `dplyr`

```{r}
(cchecks::cch_pkgs('dplyr'))$data$checks
```

What if you wanted to use this same information to create an output similar to sessioninfo, but append to it the information from the current CRAN checks for each loaded namespace (package) tailored to your platform.

This is what `craninfo` does for you!

With this information you can

- See if there are any problems with the packages that you are using in an R/Rmd script
- Attach it to a {reprex} to help the maintainer help you even more efficiently.
- See if you have the most current version of a package installed, and if not you can decide if you should install it given it's current CRAN status.
- Compare multiple CRAN check flavors with ease.

## Console Output

### Current CRAN release

```{r,R.options = list(width = 120)}
craninfo()
```

### Compare CRAN releases

```{r,R.options = list(width = 150)}
craninfo(cran_type = c('release','oldrel'))
```