Skip to content

Commit 52f458a

Browse files
authored
Merge pull request #151 from MangoTheCat/release-1.0.3
Release 1.0.3
2 parents 62ceff2 + c22b345 commit 52f458a

File tree

102 files changed

+3371
-3219
lines changed

Some content is hidden

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

102 files changed

+3371
-3219
lines changed

.Rbuildignore

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
^.*\.Rproj$
22
^\.Rproj\.user$
3-
^Makefile$
43
^README.Rmd$
5-
^.travis.yml$
6-
^appveyor.yml$
7-
^appveyor\.yml$
84
index.Rmd
95
index.md
10-
^docs$
6+
^docs$
7+
^\.github$
8+
^codecov\.yml$
9+
^LICENSE\.md$
10+
^CRAN-SUBMISSION$
11+
^cran-comments\.md$
12+
^pkgdown

.github/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.html

.github/workflows/R-CMD-check.yaml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +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: [main, master]
6+
pull_request:
7+
branches: [main, 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@v2
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

.github/workflows/pkgdown.yaml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
on:
2+
push:
3+
branches:
4+
- main
5+
- master
6+
tags:
7+
-'*'
8+
9+
name: pkgdown
10+
11+
jobs:
12+
pkgdown:
13+
runs-on: macOS-latest
14+
env:
15+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
16+
steps:
17+
- uses: actions/checkout@v2
18+
19+
- uses: r-lib/actions/setup-r@v1
20+
21+
- uses: r-lib/actions/setup-pandoc@v1
22+
23+
- name: Query dependencies
24+
run: |
25+
install.packages('remotes')
26+
saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
27+
writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
28+
shell: Rscript {0}
29+
30+
- name: Restore R package cache
31+
uses: actions/cache@v2
32+
with:
33+
path: ${{ env.R_LIBS_USER }}
34+
key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}
35+
restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-
36+
37+
- name: Install dependencies
38+
run: |
39+
remotes::install_deps(dependencies = TRUE)
40+
install.packages("pkgdown", type = "binary")
41+
shell: Rscript {0}
42+
43+
- name: Install package
44+
run: R CMD INSTALL .
45+
46+
- name: Deploy package
47+
run: |
48+
git config --local user.email "actions@github.com"
49+
git config --local user.name "GitHub Actions"
50+
Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)'
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
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: [main, master]
6+
pull_request:
7+
branches: [main, master]
8+
9+
name: test-coverage
10+
11+
jobs:
12+
test-coverage:
13+
runs-on: ubuntu-latest
14+
env:
15+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
16+
17+
steps:
18+
- uses: actions/checkout@v2
19+
20+
- uses: r-lib/actions/setup-r@v2
21+
with:
22+
use-public-rspm: true
23+
24+
- uses: r-lib/actions/setup-r-dependencies@v2
25+
with:
26+
extra-packages: any::covr
27+
needs: coverage
28+
29+
- name: Test coverage
30+
run: covr::codecov(quiet = FALSE)
31+
shell: Rscript {0}

.travis.yml

Lines changed: 0 additions & 11 deletions
This file was deleted.

DESCRIPTION

Lines changed: 54 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,59 @@
11
Package: goodpractice
22
Title: Advice on R Package Building
3-
Version: 1.0.2.9000
4-
Authors@R: c(person("Gabor", "Csardi", email = "csardi.gabor@gmail.com",
5-
role = c("aut")),
6-
person("Hannah", "Frick", email = "hfrick@mango-solutions.com",
7-
role = c("aut", "cre")))
3+
Version: 1.0.3
4+
Authors@R:
5+
c(person(given = "Ascent Digital Services UK Limited",
6+
role = "cph",
7+
comment = c(GitHub = "MangoTheCat")),
8+
person(given = "Karina",
9+
family = "Marks",
10+
role = c("aut", "cre"),
11+
email = "karina.marks@ascent.io",
12+
comment = c(GitHub = "KarinaMarks")),
13+
person(given = "Daniel",
14+
family = "de Bortoli",
15+
role = c("aut"),
16+
comment = c(GitHub = "ddbortoli")),
17+
person(given = "Gabor",
18+
family = "Csardi",
19+
role = "aut",
20+
email = "csardi.gabor@gmail.com"),
21+
person(given = "Hannah",
22+
family = "Frick",
23+
role = "aut",
24+
email = "hannah.frick@gmail.com"),
25+
person(given = "Owen",
26+
family = "Jones",
27+
role = "aut",
28+
email = "owenjonesuob@gmail.com",
29+
comment = c(GitHub = "owenjonesuob")),
30+
person(given = "Hannah",
31+
family = "Alexander",
32+
role = "aut",
33+
email = "halexander@mango-solutions.com"),
34+
person(given = "Ana",
35+
family = "Simmons",
36+
role = c("ctb"),
37+
email = "ana.simmons@ascent.io",
38+
comment = c(GitHub = "anasimmons")),
39+
person(given = "Fabian",
40+
family = "Scheipl",
41+
role = "ctb",
42+
comment = c(GitHub = "fabian-s")))
843
Description: Give advice about good practices when building R packages.
9-
Advice includes functions and syntax to avoid, package structure,
10-
code complexity, code formatting, etc.
44+
Advice includes functions and syntax to avoid, package structure, code
45+
complexity, code formatting, etc.
1146
License: MIT + file LICENSE
12-
LazyData: true
1347
URL: https://github.com/mangothecat/goodpractice
1448
BugReports: https://github.com/mangothecat/goodpractice/issues
15-
RoxygenNote: 6.0.1
16-
Suggests:
17-
testthat,
18-
knitr,
19-
rmarkdown
2049
Imports:
2150
clisymbols,
2251
covr,
2352
crayon,
2453
cyclocomp (>= 1.1.0),
2554
desc,
2655
jsonlite,
27-
lintr,
56+
lintr (>= 3.0.0),
2857
praise,
2958
rcmdcheck,
3059
rstudioapi,
@@ -34,7 +63,17 @@ Imports:
3463
withr,
3564
xml2,
3665
xmlparsedata (>= 1.0.1)
37-
Collate:
66+
Suggests:
67+
knitr,
68+
rmarkdown,
69+
testthat (>= 3.0.0)
70+
VignetteBuilder:
71+
knitr
72+
Encoding: UTF-8
73+
Roxygen: list(markdown = TRUE)
74+
RoxygenNote: 7.1.2
75+
Config/testthat/edition: 3
76+
Collate:
3877
'api.R'
3978
'customization.R'
4079
'lists.R'
@@ -58,4 +97,3 @@ Collate:
5897
'print.R'
5998
'rstudio_markers.R'
6099
'utils.R'
61-
VignetteBuilder: knitr

LICENSE

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
YEAR: 2016
2-
COPYRIGHT HOLDER: Mango Solutions
1+
YEAR: 2022
2+
COPYRIGHT HOLDER: Ascent Digital Services UK Limited

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# MIT License
2+
3+
Copyright (c) 2022 Ascent Digital Services UK Limited
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

Makefile

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)