Skip to content

Commit

Permalink
Transfer GitHub repo HenrikBengtsson/progressr to futureverse/progressr
Browse files Browse the repository at this point in the history
  • Loading branch information
HenrikBengtsson committed Oct 28, 2024
1 parent fa1d286 commit e1fba8e
Show file tree
Hide file tree
Showing 10 changed files with 68 additions and 98 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@ jobs:
LANGUAGE: ${{ matrix.config.language }}
## R CMD check
_R_CHECK_CRAN_INCOMING_: false
_R_CHECK_LENGTH_1_CONDITION_: true
_R_CHECK_LENGTH_1_LOGIC2_: true
_R_CHECK_MATRIX_DATA_: true
_R_CHECK_SUGGESTS_ONLY_: true
_R_CHECK_THINGS_IN_TEMP_DIR_: true
Expand Down
84 changes: 0 additions & 84 deletions .github/workflows/covr.yaml

This file was deleted.

56 changes: 56 additions & 0 deletions .github/workflows/test-coverage.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
on: [push]

name: test-coverage.yaml

permissions: read-all

jobs:
test-coverage:
runs-on: ubuntu-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}

steps:
- uses: actions/checkout@v4

- name: Assert CODECOV_TOKEN is set
run: |
if [[ -z "${{secrets.CODECOV_TOKEN}}" ]]; then
>&2 echo "::error::ERROR: 'secrets.CODECOV_TOKEN' not set"
exit 1
fi
- uses: r-lib/actions/setup-r@v2
with:
use-public-rspm: true

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::covr, any::xml2
needs: coverage

- name: Test coverage
run: |
cov <- covr::package_coverage(
quiet = FALSE,
clean = FALSE,
install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package")
)
print(cov)
covr::to_cobertura(cov)
shell: Rscript {0}

- uses: codecov/codecov-action@v4
with:
fail_ci_if_error: ${{ github.event_name != 'pull_request' && true || false }}
file: ./cobertura.xml
plugin: noop
disable_search: true
token: ${{ secrets.CODECOV_TOKEN }}

- name: Upload test results
if: failure()
uses: actions/upload-artifact@v4
with:
name: coverage-test-failures
path: ${{ runner.temp }}/package
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

# Contributing to the 'progressr' package

This Git repository uses the [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) branching model (the [`git flow`](https://github.com/petervanderdoes/gitflow-avh) extension is useful for this). The [`develop`](https://github.com/HenrikBengtsson/progressr/tree/develop) branch contains the latest contributions and other code that will appear in the next release, and the [`master`](https://github.com/HenrikBengtsson/progressr) branch contains the code of the latest release, which is exactly what is currently on [CRAN](https://cran.r-project.org/package=progressr).
This Git repository uses the [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) branching model (the [`git flow`](https://github.com/petervanderdoes/gitflow-avh) extension is useful for this). The [`develop`](https://github.com/futureverse/progressr/tree/develop) branch contains the latest contributions and other code that will appear in the next release, and the [`master`](https://github.com/futureverse/progressr) branch contains the code of the latest release, which is exactly what is currently on [CRAN](https://cran.r-project.org/package=progressr).

Contributing to this package is easy. Just send a [pull request](https://help.github.com/articles/using-pull-requests/). When you send your PR, make sure `develop` is the destination branch on the [progressr repository](https://github.com/HenrikBengtsson/progressr). Your PR should pass `R CMD check --as-cran`, which will also be checked by <a href="https://github.com/HenrikBengtsson/progressr/actions?query=workflow%3AR-CMD-check">GitHub Actions</a> and when the PR is submitted.
Contributing to this package is easy. Just send a [pull request](https://help.github.com/articles/using-pull-requests/). When you send your PR, make sure `develop` is the destination branch on the [progressr repository](https://github.com/futureverse/progressr). Your PR should pass `R CMD check --as-cran`, which will also be checked by <a href="https://github.com/futureverse/progressr/actions?query=workflow%3AR-CMD-check">GitHub Actions</a> and when the PR is submitted.

We abide to the [Code of Conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/) of Contributor Covenant.
6 changes: 3 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Package: progressr
Version: 0.14.0-9008
Version: 0.14.0-9009
Title: An Inclusive, Unifying API for Progress Updates
Description: A minimal, unifying API for scripts and packages to report progress updates from anywhere including when using parallel processing. The package is designed such that the developer can to focus on what progress should be reported on without having to worry about how to present it. The end user has full control of how, where, and when to render these progress updates, e.g. in the terminal using utils::txtProgressBar(), cli::cli_progress_bar(), in a graphical user interface using utils::winProgressBar(), tcltk::tkProgressBar() or shiny::withProgress(), via the speakers using beepr::beep(), or on a file system via the size of a file. Anyone can add additional, customized, progression handlers. The 'progressr' package uses R's condition framework for signaling progress updated. Because of this, progress can be reported from almost anywhere in R, e.g. from classical for and while loops, from map-reduce API:s like the lapply() family of functions, 'purrr', 'plyr', and 'foreach'. It will also work with parallel processing via the 'future' framework, e.g. future.apply::future_lapply(), furrr::future_map(), and 'foreach' with 'doFuture'. The package is compatible with Shiny applications.
Authors@R: c(person("Henrik", "Bengtsson",
Expand Down Expand Up @@ -34,7 +34,7 @@ Suggests:
base64enc,
tools
VignetteBuilder: progressr
URL: https://progressr.futureverse.org, https://github.com/HenrikBengtsson/progressr
BugReports: https://github.com/HenrikBengtsson/progressr/issues
URL: https://progressr.futureverse.org, https://github.com/futureverse/progressr
BugReports: https://github.com/futureverse/progressr/issues
RoxygenNote: 7.3.2
Roxygen: list(markdown = TRUE)
2 changes: 1 addition & 1 deletion R/handler_filesize.R
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
handler_filesize <- function(file = "default.progress", intrusiveness = getOption("progressr.intrusiveness.file", 5), target = "file", enable = getOption("progressr.enable", TRUE), ...) {
reporter <- local({
set_file_size <- function(config, state, progression, message = state$message) {
## Troubleshoot https://github.com/HenrikBengtsson/progressr/issues/168
## Troubleshoot https://github.com/futureverse/progressr/issues/168
stop_if_not(
length(config$max_steps) == 1L, is.numeric(config$max_steps),
!is.na(config$max_steps), is.finite(config$max_steps),
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@


<div id="badges"><!-- pkgdown markup -->
<a href="https://CRAN.R-project.org/web/checks/check_results_progressr.html"><img border="0" src="https://www.r-pkg.org/badges/version/progressr" alt="CRAN check status"/></a> <a href="https://github.com/HenrikBengtsson/progressr/actions?query=workflow%3AR-CMD-check"><img border="0" src="https://github.com/HenrikBengtsson/progressr/actions/workflows/R-CMD-check.yaml/badge.svg?branch=develop" alt="R CMD check status"/></a> <a href="https://github.com/HenrikBengtsson/progressr/actions?query=workflow%3Arevdepcheck-top"><img border="0" src="https://github.com/HenrikBengtsson/progressr/actions/workflows/revdepcheck-top.yaml/badge.svg?branch=develop" alt="Top reverse-dependency checks status"/></a> <a href="https://app.codecov.io/gh/HenrikBengtsson/progressr"><img border="0" src="https://codecov.io/gh/HenrikBengtsson/progressr/branch/develop/graph/badge.svg" alt="Coverage Status"/></a> <a href="https://lifecycle.r-lib.org/articles/stages.html"><img border="0" src="man/figures/lifecycle-maturing-blue.svg" alt="Life cycle: maturing"/></a>
<a href="https://CRAN.R-project.org/web/checks/check_results_progressr.html"><img border="0" src="https://www.r-pkg.org/badges/version/progressr" alt="CRAN check status"/></a> <a href="https://github.com/futureverse/progressr/actions?query=workflow%3AR-CMD-check"><img border="0" src="https://github.com/futureverse/progressr/actions/workflows/R-CMD-check.yaml/badge.svg?branch=develop" alt="R CMD check status"/></a> <a href="https://github.com/futureverse/progressr/actions?query=workflow%3Arevdepcheck-top"><img border="0" src="https://github.com/futureverse/progressr/actions/workflows/revdepcheck-top.yaml/badge.svg?branch=develop" alt="Top reverse-dependency checks status"/></a> <a href="https://app.codecov.io/gh/futureverse/progressr"><img border="0" src="https://codecov.io/gh/futureverse/progressr/branch/develop/graph/badge.svg" alt="Coverage Status"/></a> <a href="https://lifecycle.r-lib.org/articles/stages.html"><img border="0" src="man/figures/lifecycle-maturing-blue.svg" alt="Life cycle: maturing"/></a>
</div>

# progressr: An Inclusive, Unifying API for Progress Updates
Expand Down Expand Up @@ -874,7 +874,7 @@ depends on it. The roadmap for developing the API is roughly:
additional progression handlers

For a more up-to-date view on what features might be added, see
<https://github.com/HenrikBengtsson/progressr/issues>.
<https://github.com/futureverse/progressr/issues>.


## Appendix
Expand Down Expand Up @@ -1054,7 +1054,7 @@ install.packages("progressr")

To install the pre-release version that is available in Git branch `develop` on GitHub, use:
```r
remotes::install_github("HenrikBengtsson/progressr", ref="develop")
remotes::install_github("futureverse/progressr", ref="develop")
```
This will install the package from source.

Expand Down
2 changes: 1 addition & 1 deletion incl/OVERVIEW.md
Original file line number Diff line number Diff line change
Expand Up @@ -866,7 +866,7 @@ depends on it. The roadmap for developing the API is roughly:
additional progression handlers

For a more up-to-date view on what features might be added, see
<https://github.com/HenrikBengtsson/progressr/issues>.
<https://github.com/futureverse/progressr/issues>.


## Appendix
Expand Down
2 changes: 1 addition & 1 deletion pkgdown/_pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ url: https://progressr.futureverse.org
home:
links:
- text: Roadmap/Milestones
href: https://github.com/HenrikBengtsson/progressr/milestones
href: https://github.com/futureverse/progressr/milestones
- text: The Futureverse Project
href: https://www.futureverse.org/
- text: Futureverse User Forum
Expand Down
2 changes: 1 addition & 1 deletion vignettes/progressr-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -877,7 +877,7 @@ depends on it. The roadmap for developing the API is roughly:
additional progression handlers

For a more up-to-date view on what features might be added, see
<https://github.com/HenrikBengtsson/progressr/issues>.
<https://github.com/futureverse/progressr/issues>.


## Appendix
Expand Down

0 comments on commit e1fba8e

Please sign in to comment.