{"id":14068546,"url":"https://github.com/ropensci-archive/cchecks","last_synced_at":"2025-07-30T04:31:22.466Z","repository":{"id":141683979,"uuid":"132970893","full_name":"ropensci-archive/cchecks","owner":"ropensci-archive","description":":warning: ARCHIVED :warning: R client for the cranchecks.info API","archived":true,"fork":false,"pushed_at":"2022-09-09T08:00:22.000Z","size":133,"stargazers_count":15,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-13T07:15:02.302Z","etag":null,"topics":["cran","monitoring","r","r-package","rstats","testing"],"latest_commit_sha":null,"homepage":"","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/ropensci-archive.png","metadata":{"files":{"readme":"README-not.md","changelog":null,"contributing":".github/CONTRIBUTING.md","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}},"created_at":"2018-05-11T01:02:09.000Z","updated_at":"2024-02-03T15:21:06.000Z","dependencies_parsed_at":"2024-02-24T13:34:20.693Z","dependency_job_id":"e216814a-eaf9-43ae-a346-431afe525c49","html_url":"https://github.com/ropensci-archive/cchecks","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci-archive%2Fcchecks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci-archive%2Fcchecks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci-archive%2Fcchecks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci-archive%2Fcchecks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ropensci-archive","download_url":"https://codeload.github.com/ropensci-archive/cchecks/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228082318,"owners_count":17866603,"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","monitoring","r","r-package","rstats","testing"],"created_at":"2024-08-13T07:06:15.476Z","updated_at":"2024-12-04T09:31:00.565Z","avatar_url":"https://github.com/ropensci-archive.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"cchecks\n=======\n\n\n\n[![R-CMD-check](https://github.com/ropensci/cchecks/workflows/R-CMD-check/badge.svg)](https://github.com/ropensci/cchecks/actions/)\n[![codecov.io](https://codecov.io/github/ropensci/cchecks/coverage.svg?branch=master)](https://codecov.io/github/ropensci/cchecks?branch=master)\n\nR client for the CRAN checks API at \u003chttps://cranchecks.info\u003e\n\n[CRAN checks API docs][docs]\n\nauthentication is only needed for the CRAN checks API for the functions that start with `cchn`\n\nSee https://docs.ropensci.org/cchecks for full documentation on `cchecks`\n\n## Install\n\n\n```r\nremotes::install_github(\"ropensci/cchecks\")\n```\n\n\n```r\nlibrary(\"cchecks\")\n```\n\n## heartbeat\n\n- `cch_heartbeat()`\n\n## packages\n\n- current day package check data: `cch_pkgs()` or `cch_pkgs(\"packagename\")`\n- historical package check data (30 days back): `cch_pkgs_history()`\n- historical package check data for all packages by day: `cch_history()`\n- search historical data: `cch_pkgs_search()`\n\nThere's an important shortcoming of historical data. The links in the historical\ndata in the `checks` field are not date specific. If you go to a link in historical\ndata, for example for April 2nd, 2020, links in that set of data link to whatever\nthe current check data is for that package. The `check_details` field is\ndate specific though; the text is scraped from the package checks page each day\nand stored, so you can count on that to be date specific. There are sometimes\nlinks to further checks, often of compiled packages on various types of checks\nthat CRAN runs; we do not have those check results - we could get them but \nhave not take the time to sort that out.\n\n\n## maintainers\n\n- all maintainers: `cch_maintainers()`\n- maintainers by email: `cch_maintainers(\"maelle.salmon_at_yahoo.se\")`\n\n## notifications\n\nFunctions for working with notifications are all prefixed with `cchn`. \n\n`cchn` functions are designed to be used from within an R package directory. The functions\nlook for the package name and maintainer email address. Functions copy heavily from \nhttps://github.com/r-hub/rhub\n\nThe functions\n\n- `cchn_register()`: registration\n- `cchn_pkg_rule_list()`/`cchn_rule_list()`: list your own rules\n- `cchn_pkg_rule_get()`/`cchn_rule_get()`: get a rule by id\n- `cchn_pkg_rule_add()`/`cchn_rule_add()`: create a rule\n- `cchn_pkg_rule_delete()`/`cchn_rule_delete()`: delete a rule by id (get id from `cchn_pkg_rule_list`/`cchn_rule_list`)\n\nFunctions prefixed with `cchn_pkg_` operate within a package \ndirectory. That is, your current working directory is an R\npackage, and is the package for which you want to handle CRAN checks \nnotifications. These functions make sure that you are inside of \nan R package, and use the email address and package name based\non the directory you're in.\n\nFunctions prefixed with just `cchn_` do not operate within a package.\nThese functions do not guess package name at all, but require the user\nto supply a package name (for those functions that require a package name);\nand instead of guessing an email address from your package, we guess email\nfrom the cached cchecks email file (see `?cchn_register`).\n\nThe first thing to do is to register an email address. In an R session in a working directory for \none of your packages that is on CRAN, run `cchn_register()`. This function:\n\n- registers your email address\n- a validation email is sent to you right away with your token\n- paste the token from the amil into the R session\n- the email and token are then saved in a file on your machine\n- all `cchn_rule*` functions use this cached token\n- you don't need to pass the token in any `cchn` function calls\n\nIf you run `cchn_register()` in the same package directory (with the same email address), \nyou'll be issued a new token, which will be updated in your cached token file.\n\nIt's entirely possible to have more than one email address you use across different R packages. \nIf you run `cchn_register()` in a different package directory (with a different email address\nfrom a previous run of `cchn_register()`), you'll be issued a different token associated \nwith that new email address.\n\nSee `?cchn_rules` for details on how the rules work and many examples of adding rules.\n\nNote that you can only manage your own rules. You can not list, get, or delete rules \nof other users.\n\n## Meta\n\n* Please [report any issues or bugs](https://github.com/ropensci/cchecks/issues).\n* License: MIT\n* Get citation information for `cchecks` in R doing `citation(package = 'cchecks')`\n* Please note that this project is released with a [Contributor Code of Conduct][coc]. By participating in this project you agree to abide by its terms.\n\n[docs]: https://cranchecks.info/docs\n[coc]: https://github.com/ropensci/cchecks/blob/master/CODE_OF_CONDUCT.md\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fropensci-archive%2Fcchecks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fropensci-archive%2Fcchecks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fropensci-archive%2Fcchecks/lists"}