Skip to content

Commit 9e694b3

Browse files
atsyplenkovatsyplenkov
authored
Merge pull request #16 from atsyplenkov/wsl
ropensci pkgcheck ✔
2 parents afe4a2e + ceaca9a commit 9e694b3

47 files changed

Lines changed: 2869 additions & 2534 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.Rbuildignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,6 @@
1515
^vignettes/articles/\.quarto$
1616
^vignettes/articles/*_files$
1717
^vignettes/articles$
18+
^codemeta\.json$
19+
^CODE_OF_CONDUCT\.md$
20+
^src/.*\.o$

‎.github/CONTRIBUTING.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing to tidyhydro
2+
3+
This outlines how to propose a change to tidyhydro.
4+
For a detailed discussion on contributing to this and other tidyverse packages, please see the [development contributing guide](https://rstd.io/tidy-contrib) and our [code review principles](https://code-review.tidyverse.org/).
5+
6+
## Fixing typos
7+
8+
You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the _source_ file.
9+
This generally means you'll need to edit [roxygen2 comments](https://roxygen2.r-lib.org/articles/roxygen2.html) in an `.R`, not a `.Rd` file.
10+
You can find the `.R` file that generates the `.Rd` by reading the comment in the first line.
11+
12+
## Bigger changes
13+
14+
If you want to make a bigger change, it's a good idea to first file an issue and make sure someone from the team agrees that it’s needed.
15+
If you’ve found a bug, please file an issue that illustrates the bug with a minimal
16+
[reprex](https://www.tidyverse.org/help/#reprex) (this will also help you write a unit test, if needed).
17+
See our guide on [how to create a great issue](https://code-review.tidyverse.org/issues/) for more advice.
18+
19+
### Pull request process
20+
21+
* Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("atsyplenkov/tidyhydro", fork = TRUE)`.
22+
23+
* Install all development dependencies with `devtools::install_dev_deps()`, and then make sure the package passes R CMD check by running `devtools::check()`.
24+
If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing.
25+
* Create a Git branch for your pull request (PR). We recommend using `usethis::pr_init("brief-description-of-change")`.
26+
27+
* Make your changes, commit to git, and then create a PR by running `usethis::pr_push()`, and following the prompts in your browser.
28+
The title of your PR should briefly describe the change.
29+
The body of your PR should contain `Fixes #issue-number`.
30+
31+
* For user-facing changes, add a bullet to the top of `NEWS.md` (i.e. just below the first header). Follow the style described in <https://style.tidyverse.org/news.html>.
32+
33+
### Code style
34+
35+
* New code should follow the tidyverse [style guide](https://style.tidyverse.org).
36+
You can use the [styler](https://CRAN.R-project.org/package=styler) package to apply these styles, but please don't restyle code that has nothing to do with your PR.
37+
38+
* We use [roxygen2](https://cran.r-project.org/package=roxygen2), with [Markdown syntax](https://cran.r-project.org/web/packages/roxygen2/vignettes/rd-formatting.html), for documentation.
39+
40+
* We use [testthat](https://cran.r-project.org/package=testthat) for unit tests.
41+
Contributions with test cases included are easier to accept.
42+
43+
## Code of Conduct
44+
45+
Please note that the tidyhydro project is released with a
46+
[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this
47+
project you agree to abide by its terms.

‎.github/workflows/check-no-suggests.yaml‎

Lines changed: 58 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,59 @@
1-
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2-
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
3-
#
4-
# NOTE: This workflow only directly installs "hard" dependencies, i.e. Depends,
5-
# Imports, and LinkingTo dependencies. Notably, Suggests dependencies are never
6-
# installed, with the exception of testthat, knitr, and rmarkdown. The cache is
7-
# never used to avoid accidentally restoring a cache containing a suggested
8-
# dependency.
9-
on:
10-
push:
11-
branches: master
12-
pull_request:
13-
14-
name: check-no-suggests.yaml
15-
16-
permissions: read-all
17-
18-
jobs:
19-
check-no-suggests:
20-
runs-on: ${{ matrix.config.os }}
21-
22-
name: ${{ matrix.config.os }} (${{ matrix.config.r }})
23-
24-
strategy:
25-
fail-fast: false
26-
matrix:
27-
config:
28-
- {os: ubuntu-latest, r: 'release'}
29-
30-
env:
31-
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
32-
R_KEEP_PKG_SOURCE: yes
33-
34-
steps:
35-
- uses: actions/checkout@v4
36-
37-
- uses: r-lib/actions/setup-pandoc@v2
38-
39-
- uses: r-lib/actions/setup-r@v2
40-
with:
41-
r-version: ${{ matrix.config.r }}
42-
http-user-agent: ${{ matrix.config.http-user-agent }}
43-
use-public-rspm: true
44-
45-
- uses: r-lib/actions/setup-r-dependencies@v2
46-
with:
47-
dependencies: '"hard"'
48-
cache: false
49-
extra-packages: |
50-
any::rcmdcheck
51-
any::testthat
52-
any::knitr
53-
any::rmarkdown
54-
needs: check
55-
56-
- uses: r-lib/actions/check-r-package@v2
57-
with:
58-
upload-snapshots: true
1+
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2+
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
3+
#
4+
# NOTE: This workflow only directly installs "hard" dependencies, i.e. Depends,
5+
# Imports, and LinkingTo dependencies. Notably, Suggests dependencies are never
6+
# installed, with the exception of testthat, knitr, and rmarkdown. The cache is
7+
# never used to avoid accidentally restoring a cache containing a suggested
8+
# dependency.
9+
on:
10+
push:
11+
branches: master
12+
pull_request:
13+
14+
name: check-no-suggests.yaml
15+
16+
permissions: read-all
17+
18+
jobs:
19+
check-no-suggests:
20+
runs-on: ${{ matrix.config.os }}
21+
22+
name: ${{ matrix.config.os }} (${{ matrix.config.r }})
23+
24+
strategy:
25+
fail-fast: false
26+
matrix:
27+
config:
28+
- {os: ubuntu-latest, r: 'release'}
29+
30+
env:
31+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
32+
R_KEEP_PKG_SOURCE: yes
33+
34+
steps:
35+
- uses: actions/checkout@v4
36+
37+
- uses: r-lib/actions/setup-pandoc@v2
38+
39+
- uses: r-lib/actions/setup-r@v2
40+
with:
41+
r-version: ${{ matrix.config.r }}
42+
http-user-agent: ${{ matrix.config.http-user-agent }}
43+
use-public-rspm: true
44+
45+
- uses: r-lib/actions/setup-r-dependencies@v2
46+
with:
47+
dependencies: '"hard"'
48+
cache: false
49+
extra-packages: |
50+
any::rcmdcheck
51+
any::testthat
52+
any::knitr
53+
any::rmarkdown
54+
needs: check
55+
56+
- uses: r-lib/actions/check-r-package@v2
57+
with:
58+
upload-snapshots: true
5959
build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'

‎.github/workflows/check-r-pkg.yaml‎

Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,50 @@
1-
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2-
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
3-
on:
4-
push:
5-
branches: master
6-
pull_request:
7-
branches: master
8-
9-
name: R-CMD-check
10-
11-
jobs:
12-
R-CMD-check:
13-
runs-on: ${{ matrix.config.os }}
14-
15-
name: ${{ matrix.config.os }} (${{ matrix.config.r }})
16-
17-
strategy:
18-
fail-fast: false
19-
matrix:
20-
config:
21-
- {os: macos-latest, r: 'release'}
22-
- {os: windows-latest, r: 'release'}
23-
- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'}
24-
- {os: ubuntu-latest, r: 'release'}
25-
- {os: ubuntu-latest, r: 'oldrel-1'}
26-
27-
env:
28-
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
29-
R_KEEP_PKG_SOURCE: yes
30-
31-
steps:
32-
- uses: actions/checkout@v4
33-
34-
- uses: r-lib/actions/setup-pandoc@v2
35-
36-
- uses: r-lib/actions/setup-r@v2
37-
with:
38-
r-version: ${{ matrix.config.r }}
39-
http-user-agent: ${{ matrix.config.http-user-agent }}
40-
use-public-rspm: true
41-
42-
- uses: r-lib/actions/setup-r-dependencies@v2
43-
with:
44-
extra-packages: any::rcmdcheck
45-
needs: check
46-
47-
- uses: r-lib/actions/check-r-package@v2
48-
with:
49-
upload-snapshots: true
50-
build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'
1+
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2+
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
3+
on:
4+
push:
5+
branches: master]
6+
pull_request:
7+
branches: master
8+
9+
name: R-CMD-check
10+
11+
jobs:
12+
R-CMD-check:
13+
runs-on: ${{ matrix.config.os }}
14+
15+
name: ${{ matrix.config.os }} (${{ matrix.config.r }})
16+
17+
strategy:
18+
fail-fast: false
19+
matrix:
20+
config:
21+
- {os: macos-latest, r: 'release'}
22+
- {os: windows-latest, r: 'release'}
23+
- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'}
24+
- {os: ubuntu-latest, r: 'release'}
25+
- {os: ubuntu-latest, r: 'oldrel-1'}
26+
27+
env:
28+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
29+
R_KEEP_PKG_SOURCE: yes
30+
31+
steps:
32+
- uses: actions/checkout@v4
33+
34+
- uses: r-lib/actions/setup-pandoc@v2
35+
36+
- uses: r-lib/actions/setup-r@v2
37+
with:
38+
r-version: ${{ matrix.config.r }}
39+
http-user-agent: ${{ matrix.config.http-user-agent }}
40+
use-public-rspm: true
41+
42+
- uses: r-lib/actions/setup-r-dependencies@v2
43+
with:
44+
extra-packages: any::rcmdcheck
45+
needs: check
46+
47+
- uses: r-lib/actions/check-r-package@v2
48+
with:
49+
upload-snapshots: true
50+
build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'

‎.github/workflows/pkgdown.yaml‎

Lines changed: 49 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,49 @@
1-
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2-
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
3-
on:
4-
push:
5-
branches: master
6-
pull_request:
7-
release:
8-
types: [published]
9-
workflow_dispatch:
10-
11-
name: pkgdown.yaml
12-
13-
permissions: read-all
14-
15-
jobs:
16-
pkgdown:
17-
runs-on: ubuntu-latest
18-
# Only restrict concurrency for non-PR jobs
19-
concurrency:
20-
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
21-
env:
22-
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
23-
permissions:
24-
contents: write
25-
steps:
26-
- uses: actions/checkout@v4
27-
28-
- uses: r-lib/actions/setup-pandoc@v2
29-
30-
- uses: r-lib/actions/setup-r@v2
31-
with:
32-
use-public-rspm: true
33-
34-
- uses: r-lib/actions/setup-r-dependencies@v2
35-
with:
36-
extra-packages: any::pkgdown, local::.
37-
needs: website
38-
39-
- name: Build site
40-
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
41-
shell: Rscript {0}
42-
43-
- name: Deploy to GitHub pages 🚀
44-
if: github.event_name != 'pull_request'
45-
uses: JamesIves/github-pages-deploy-action@v4.5.0
46-
with:
47-
clean: false
48-
branch: gh-pages
49-
folder: docs
1+
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2+
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
3+
on:
4+
push:
5+
branches: master
6+
pull_request:
7+
release:
8+
types: [published]
9+
workflow_dispatch:
10+
11+
name: pkgdown.yaml
12+
13+
permissions: read-all
14+
15+
jobs:
16+
pkgdown:
17+
runs-on: ubuntu-latest
18+
# Only restrict concurrency for non-PR jobs
19+
concurrency:
20+
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
21+
env:
22+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
23+
permissions:
24+
contents: write
25+
steps:
26+
- uses: actions/checkout@v4
27+
28+
- uses: r-lib/actions/setup-pandoc@v2
29+
30+
- uses: r-lib/actions/setup-r@v2
31+
with:
32+
use-public-rspm: true
33+
34+
- uses: r-lib/actions/setup-r-dependencies@v2
35+
with:
36+
extra-packages: any::pkgdown, local::.
37+
needs: website
38+
39+
- name: Build site
40+
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
41+
shell: Rscript {0}
42+
43+
- name: Deploy to GitHub pages 🚀
44+
if: github.event_name != 'pull_request'
45+
uses: JamesIves/github-pages-deploy-action@v4.5.0
46+
with:
47+
clean: false
48+
branch: gh-pages
49+
folder: docs

0 commit comments

Comments
 (0)