{"id":14066805,"url":"https://github.com/fmichonneau/foghorn","last_synced_at":"2025-04-09T18:19:11.873Z","repository":{"id":55050561,"uuid":"72576490","full_name":"fmichonneau/foghorn","owner":"fmichonneau","description":":loudspeaker: :ship: R package to summarize CRAN Check Results in the Terminal","archived":false,"fork":false,"pushed_at":"2024-07-02T15:07:51.000Z","size":5358,"stargazers_count":56,"open_issues_count":9,"forks_count":6,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-09T18:19:05.950Z","etag":null,"topics":["cran","feedback","r"],"latest_commit_sha":null,"homepage":"https://fmichonneau.github.io/foghorn/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fmichonneau.png","metadata":{"files":{"readme":"README.Rmd","changelog":"NEWS.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-11-01T21:02:59.000Z","updated_at":"2025-03-22T11:18:40.000Z","dependencies_parsed_at":"2024-06-11T16:59:17.127Z","dependency_job_id":"88c16d12-138a-4cd9-a0bb-fcdbc7b9af60","html_url":"https://github.com/fmichonneau/foghorn","commit_stats":{"total_commits":448,"total_committers":5,"mean_commits":89.6,"dds":0.03125,"last_synced_commit":"125dd3129a270cdfd26299a78c9b3483876c167f"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fmichonneau%2Ffoghorn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fmichonneau%2Ffoghorn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fmichonneau%2Ffoghorn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fmichonneau%2Ffoghorn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fmichonneau","download_url":"https://codeload.github.com/fmichonneau/foghorn/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248085325,"owners_count":21045139,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cran","feedback","r"],"created_at":"2024-08-13T07:05:16.198Z","updated_at":"2025-04-09T18:19:11.845Z","avatar_url":"https://github.com/fmichonneau.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n[![R-CMD-check](https://github.com/fmichonneau/foghorn/actions/workflows/check-full.yaml/badge.svg)](https://github.com/fmichonneau/foghorn/actions/workflows/check-full.yaml)\n[![Coverage Status](https://img.shields.io/codecov/c/github/fmichonneau/foghorn/master.svg)](https://app.codecov.io/github/fmichonneau/foghorn?branch=master)\n[![CRAN version](https://www.r-pkg.org/badges/version/foghorn)](https://www.r-pkg.org/pkg/foghorn)\n[![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/foghorn)](https://www.r-pkg.org/pkg/foghorn)\n\n```{r, echo = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"README-\"\n)\n```\n\n# foghorn \u003cimg src=\"man/figures/logo.png\" align=\"right\" /\u003e\n\n\u003e **foghorn** *noun* \u003cbr\u003e\n\u003e     1. Device used to facilitate navigation in foggy conditions by warning of\n\u003e        potential hazards ahead.\n\n`foghorn` makes accessible to the R terminal the CRAN check results for packages\nmaintained by individuals, or for other packages of interest. The results are\npresented as a colored summary, or as a tibble. The function that generates the\nsummary is designed to be called from your `.Rprofile` so you can check on the\nstatus of the packages regularly.\n\nAs new features are introduced in development versions of R, or new policies are\nput in place, packages that are not updated frequently may start generating\nwarnings or errors when checked on CRAN's infrastructure. `foghorn` brings this\ninformation to your terminal so you don't have to leave the comfort of your\nR session to know the results of the CRAN checks for your packages.\n\n## Installation\n\nYou can install the development version of **`foghorn`** from GitHub with:\n\n```{r gh-installation, eval = FALSE}\npak::pkg_install(\"fmichonneau/foghorn\")\n```\n\nor the stable version from CRAN:\n\n```{r cran-install, eval=FALSE}\ninstall.packages(\"foghorn\")\n```\n\n## Demonstration\n\n```{r example}\n## load the package\nlibrary(foghorn)\n```\n\n`foghorn` provides the results of the package CRAN checks. As a maintainer, you\ncan easily get the results of the checks for your packages by using the email\naddress included in the `DESCRIPTION` file of your packages.\n\n`summary_cran_results()` provides you with a graphical summary of the results of\nthe CRAN checks. The number in parenthesis after the name of the package\nindicates the number of platforms used by CRAN that produced this result. If\nCRAN has set a deadline by which your package needs to be updated before it gets\narchived, that date will be shown in the output.\n\n```{r graphical-interface}\n## Graphical interface\nsummary_cran_results(email = \"francois.michonneau@gmail.com\", pkg = \"lme4\")\n```\n\n`summary_cran_results()` is actually an alias of `summary(cran_results())`,\nmeaning that you can call `cran_results()` directly if you want to easily access\nthe underlying data for the results of the CRAN checks. These results are stored\nin a tibble.\n\n```{r tibble}\n## Results of the checks as a tibble\ncran_results(email = \"francois.michonneau@gmail.com\")\n```\n\nIn addition of your own packages, you can also check the results for any other\npackages that might be of interest to you:\n\n```{r package-name}\n## either by themselves\nsummary_cran_results(pkg = c(\"ggplot2\", \"dplyr\"))\n\ncran_results(pkg = c(\"ggplot2\", \"dplyr\"))\n\n## or by combining them with email addresses\nsummary_cran_results(\n  email = \"francois.michonneau@gmail.com\",\n  pkg = c(\"arrow\", \"duckdb\")\n)\n\ncran_results(\n  email = \"francois.michonneau@gmail.com\",\n  pkg = c(\"arrow\", \"duckdb\")\n)\n```\n\nYou can inspect the logs for the check results using `summary_cran_details(pkg)`\n(or `summary(cran_details(pkg))`), while `visit_cran_check(pkg)` takes you\ndirectly to the CRAN webpage.\n\n```{r cran-details}\n(tidyr_checks \u003c- cran_details(pkg = \"tidyr\"))\nsummary(tidyr_checks)\n```\n\n## Where does the data come from?\n\nThe data from the check results used by this package are either scraped from\nthe CRAN web pages (default), or are from the CRAN database (that CRAN uses to\nbuild the webpages). The first option is faster if you want to regularly check a\nfew packages. However, if you are doing statistics on a large number of\npackages, using the CRAN database is recommended (it's about 20Mb of data). To\nuse the CRAN database, add `src = \"crandb\"` in your function calls:\n\n```{r show-cran-db}\ncran_results(pkg = \"nlme\", src = \"crandb\", progress = FALSE)\n```\n\nCheck out the \"Details\" section in the help files for more information.\n\n\n## Feedback? Suggestions?\n\nFeel free to submit feedback and suggestions\nby [opening an issue](https://github.com/fmichonneau/foghorn/issues/new) on\nGitHub.\n\n\n## Code of Conduct\n\nPlease note that this project is released with\na [Contributor Code of Conduct](https://fmichonneau.github.io/foghorn/CODE_OF_CONDUCT.html). By participating in this project\nyou agree to abide by its terms.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffmichonneau%2Ffoghorn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffmichonneau%2Ffoghorn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffmichonneau%2Ffoghorn/lists"}