Skip to content

Commit 82553e2

Browse files
hbanieckihbaniecki
committed
update README
1 parent 9f665e5 commit 82553e2

File tree

242 files changed

+277
-31351
lines changed

Some content is hidden

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

242 files changed

+277
-31351
lines changed

Diff for: ‎.Rbuildignore

+1
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,4 @@ README_files
1818
README.md
1919
pkgdown
2020
^CRAN-RELEASE$
21+
^\.github$

Diff for: ‎.gitattributes

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
docs/* linguist-documentation
2+
man/* linguist-documentation
3+
misc/* linguist-documentation
4+
pkgdown/* linguist-documentation

Diff for: ‎.github/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.html

Diff for: ‎.github/workflows/R-CMD-check.yaml

+107
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
on:
2+
push:
3+
branches:
4+
- master
5+
- 'dev*'
6+
- 'fix*'
7+
- 'issue*'
8+
- 'r*'
9+
- 'doc*'
10+
- 'gh-actions'
11+
- 'githubactions'
12+
paths:
13+
- '**.R'
14+
- '**.r'
15+
- '*DESCRIPTION'
16+
- '**.Rmd'
17+
- '**.rmd'
18+
- '**.rda'
19+
- '**.Rda'
20+
- '**.rds'
21+
- '**.Rds'
22+
pull_request:
23+
branches:
24+
- master
25+
paths:
26+
- '**.R'
27+
- '**.r'
28+
- '*DESCRIPTION'
29+
- '**.Rmd'
30+
- '**.rmd'
31+
- '**.rda'
32+
- '**.Rda'
33+
- '**.rds'
34+
- '**.Rds'
35+
36+
name: R-CMD-check
37+
38+
jobs:
39+
R-CMD-check:
40+
runs-on: ${{ matrix.config.os }}
41+
42+
name: ${{ matrix.config.os }} (${{ matrix.config.r }})
43+
44+
strategy:
45+
fail-fast: false
46+
matrix:
47+
config:
48+
- {os: windows-latest, r: '3.6'}
49+
- {os: macOS-latest, r: '3.6'}
50+
- {os: macOS-latest, r: 'devel'}
51+
- {os: ubuntu-16.04, r: '3.5', rspm: "https://demo.rstudiopm.com/all/__linux__/xenial/latest"}
52+
- {os: ubuntu-16.04, r: '3.6', rspm: "https://demo.rstudiopm.com/all/__linux__/xenial/latest"}
53+
54+
env:
55+
R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
56+
RSPM: ${{ matrix.config.rspm }}
57+
58+
steps:
59+
- uses: actions/checkout@v2
60+
61+
- uses: r-lib/actions/setup-r@master
62+
with:
63+
r-version: ${{ matrix.config.r }}
64+
65+
- uses: r-lib/actions/setup-pandoc@master
66+
67+
- name: Query dependencies
68+
run: |
69+
install.packages('remotes')
70+
saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
71+
shell: Rscript {0}
72+
73+
- name: Cache R packages
74+
if: runner.os != 'Windows'
75+
uses: actions/cache@v1
76+
with:
77+
path: ${{ env.R_LIBS_USER }}
78+
key: ${{ runner.os }}-r-${{ matrix.config.r }}-${{ hashFiles('.github/depends.Rds') }}
79+
restore-keys: ${{ runner.os }}-r-${{ matrix.config.r }}-
80+
81+
- name: Install system dependencies
82+
if: runner.os == 'Linux'
83+
env:
84+
RHUB_PLATFORM: linux-x86_64-ubuntu-gcc
85+
run: |
86+
Rscript -e "remotes::install_github('r-hub/sysreqs')"
87+
sysreqs=$(Rscript -e "cat(sysreqs::sysreq_commands('DESCRIPTION'))")
88+
sudo -s eval "$sysreqs"
89+
90+
- name: Install dependencies
91+
run: |
92+
remotes::install_deps(dependencies = TRUE)
93+
remotes::install_cran("rcmdcheck")
94+
shell: Rscript {0}
95+
96+
- name: Check
97+
env:
98+
_R_CHECK_CRAN_INCOMING_REMOTE_: false
99+
run: rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran", "--run-donttest", "--run-dontrun"), error_on = "warning", check_dir = "check")
100+
shell: Rscript {0}
101+
102+
- name: Upload check results
103+
if: failure()
104+
uses: actions/upload-artifact@master
105+
with:
106+
name: ${{ runner.os }}-r${{ matrix.config.r }}-results
107+
path: check

Diff for: ‎.github/workflows/pkgdown.yaml

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
on:
2+
push:
3+
branches: master
4+
5+
name: pkgdown
6+
7+
jobs:
8+
pkgdown:
9+
runs-on: macOS-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
13+
- uses: r-lib/actions/setup-r@master
14+
15+
- uses: r-lib/actions/setup-pandoc@master
16+
17+
- name: Query dependencies
18+
run: |
19+
install.packages('remotes')
20+
saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
21+
shell: Rscript {0}
22+
23+
- name: Cache R packages
24+
uses: actions/cache@v1
25+
with:
26+
path: ${{ env.R_LIBS_USER }}
27+
key: macOS-r-3.6-${{ hashFiles('.github/depends.Rds') }}
28+
restore-keys: macOS-r-3.6-
29+
30+
- name: Install dependencies
31+
run: |
32+
install.packages("remotes")
33+
remotes::install_deps(dependencies = TRUE)
34+
remotes::install_dev("pkgdown")
35+
remotes::install_github("ModelOriented/DrWhyTemplate")
36+
shell: Rscript {0}
37+
38+
- name: Install package
39+
run: R CMD INSTALL .
40+
41+
- name: Deploy package
42+
run: pkgdown::deploy_to_branch(new_process = FALSE)
43+
shell: Rscript {0}

Diff for: ‎.github/workflows/pr-commands.yaml

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
on:
2+
issue_comment:
3+
types: [created]
4+
name: Commands
5+
jobs:
6+
document:
7+
if: startsWith(github.event.comment.body, '/document')
8+
name: document
9+
runs-on: macOS-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
- uses: r-lib/actions/pr-fetch@master
13+
with:
14+
repo-token: ${{ secrets.GITHUB_TOKEN }}
15+
- uses: r-lib/actions/setup-r@master
16+
- name: Install dependencies
17+
run: Rscript -e 'install.packages(c("remotes", "roxygen2"))' -e 'remotes::install_deps(dependencies = TRUE)'
18+
- name: Document
19+
run: Rscript -e 'roxygen2::roxygenise()'
20+
- name: commit
21+
run: |
22+
git add man/\* NAMESPACE
23+
git commit -m 'Document'
24+
- uses: r-lib/actions/pr-push@master
25+
with:
26+
repo-token: ${{ secrets.GITHUB_TOKEN }}
27+
style:
28+
if: startsWith(github.event.comment.body, '/style')
29+
name: style
30+
runs-on: macOS-latest
31+
steps:
32+
- uses: actions/checkout@v2
33+
- uses: r-lib/actions/pr-fetch@master
34+
with:
35+
repo-token: ${{ secrets.GITHUB_TOKEN }}
36+
- uses: r-lib/actions/setup-r@master
37+
- name: Install dependencies
38+
run: Rscript -e 'install.packages("styler")'
39+
- name: Style
40+
run: Rscript -e 'styler::style_pkg()'
41+
- name: commit
42+
run: |
43+
git add \*.R
44+
git commit -m 'Style'
45+
- uses: r-lib/actions/pr-push@master
46+
with:
47+
repo-token: ${{ secrets.GITHUB_TOKEN }}
48+
# A mock job just to ensure we have a successful build status
49+
finish:
50+
runs-on: ubuntu-latest
51+
steps:
52+
- run: true

Diff for: ‎.github/workflows/test-coverage.yaml

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
on:
2+
push:
3+
branches:
4+
- master
5+
pull_request:
6+
branches:
7+
- master
8+
9+
name: test-coverage
10+
11+
jobs:
12+
test-coverage:
13+
runs-on: macOS-latest
14+
steps:
15+
- uses: actions/checkout@v2
16+
17+
- uses: r-lib/actions/setup-r@master
18+
19+
- uses: r-lib/actions/setup-pandoc@master
20+
21+
- name: Query dependencies
22+
run: |
23+
install.packages('remotes')
24+
saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
25+
shell: Rscript {0}
26+
27+
- name: Cache R packages
28+
uses: actions/cache@v1
29+
with:
30+
path: ${{ env.R_LIBS_USER }}
31+
key: macOS-r-3.6-${{ hashFiles('.github/depends.Rds') }}
32+
restore-keys: macOS-r-3.6-
33+
34+
- name: Install dependencies
35+
run: |
36+
install.packages(c("remotes"))
37+
remotes::install_deps(dependencies = TRUE)
38+
remotes::install_cran("covr")
39+
shell: Rscript {0}
40+
41+
- name: Test coverage
42+
run: covr::codecov()
43+
shell: Rscript {0}

Diff for: ‎.travis.yml

-19
This file was deleted.

Diff for: ‎DESCRIPTION

+3-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Authors@R: c(
1515
Description: Provides an easy to use unified interface for creating validation plots for any model.
1616
The 'auditor' helps to avoid repetitive work consisting of writing code needed to create residual plots.
1717
This visualizations allow to asses and compare the goodness of fit, performance, and similarity of models.
18-
Depends: R (>= 3.0.0)
18+
Depends: R (>= 3.5.0)
1919
License: GPL
2020
Encoding: UTF-8
2121
LazyData: true
@@ -36,7 +36,8 @@ Suggests:
3636
r2d3,
3737
randomForest,
3838
rmarkdown,
39-
testthat
39+
testthat,
40+
covr
4041
VignetteBuilder: knitr
4142
URL: https://github.com/ModelOriented/auditor
4243
BugReports: https://github.com/ModelOriented/auditor/issues

Diff for: ‎NEWS.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# auditor (development)
22
* new default color palete `DALEX::colors_discrete_drwhy`
3+
* depend on `R v3.5` to comply with `DALEX`
34

45
# auditor 1.2.0
56
* Change `score` parameter to `type` in `score()` function

0 commit comments

Comments
 (0)