Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/r-hub/cransays
Creates an Overview of CRAN Incoming Submissions :mailbox_with_mail:
https://github.com/r-hub/cransays
cran cran-r r r-package r-packages rstats
Last synced: 3 months ago
JSON representation
Creates an Overview of CRAN Incoming Submissions :mailbox_with_mail:
- Host: GitHub
- URL: https://github.com/r-hub/cransays
- Owner: r-hub
- License: other
- Created: 2018-10-09T07:24:47.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T23:11:17.000Z (7 months ago)
- Last Synced: 2024-04-14T00:43:29.563Z (7 months ago)
- Topics: cran, cran-r, r, r-package, r-packages, rstats
- Language: R
- Homepage: https://r-hub.github.io/cransays/articles/dashboard.html
- Size: 159 MB
- Stars: 75
- Watchers: 2
- Forks: 10
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - r-hub/cransays - Creates an Overview of CRAN Incoming Submissions :mailbox_with_mail: (R)
README
# cransays
[](https://www.repostatus.org/#active)
[](https://github.com/r-hub/cransays/actions/workflows/R-CMD-check.yaml)
The goal of cransays is to scrape the [CRAN incoming ftp folder](ftp://cran.r-project.org/incoming/) to find where each of the submission is, and to
make a [dashboard](https://r-hub.github.io/cransays/articles/dashboard.html).
## Installation
``` r
remotes::install_github("r-hub/cransays")
```
## Example
This is a basic example :
``` r
cran_incoming <- cransays::take_snapshot()
```
The vignette produces a [handy dashboard](https://r-hub.github.io/cransays/articles/dashboard.html) that we update every hour via [GitHub Actions](https://github.com/r-hub/cransays/actions).
## Historical data
Hourly snapshots of the ftp server are saved in the [`history` branch](https://github.com/r-hub/cransays/tree/history), as part of our [rendering workflow](https://github.com/r-hub/cransays/blob/c54ec4bf7c05e9c91510176dd933d103b59a6779/.github/workflows/render-dashboard.yml#L48-L67).
A short script to load this historical data as a `data.frame` is also provided in the package:
``` r
historical_data <- cransays::download_history()
```
## Related work
* Code originally adapted from https://github.com/edgararuiz/cran-stages That repository features an interesting analysis of CRAN incoming folder, including a diagram of the process deducted from that analysis.
* The [`foghorn` package](https://github.com/fmichonneau/foghorn), to summarize CRAN Check Results in the Terminal, provides an `foghorn::cran_incoming()` function to where your package stands in the CRAN incoming queue.
* The [cransubs website](https://nx10.github.io/cransubs/) provides a similar dashboard by taking a completely different technical approach. Instead of downloading the queue data and rendering the dashboard as a static site, it fetches the data on the fly and as needed. It is particularly well suited if you wish more regular updates than the hourly schedule of cransays, but it doesn't provide [snapshots of historical data](#historical-data).
* If you wanna increase the chance of a smooth submission, check out [this collaborative list of things to know before submitting to CRAN](https://github.com/ThinkR-open/prepare-for-cran).
## Contributing
Wanna report a bug or suggest a feature? Great stuff! For more information on how to contribute check out [our contributing guide](.github/CONTRIBUTING.md).
Please note that this R package is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this package project you agree to abide by its terms.