Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bugfix/86 align with current auditor version #87

Open
wants to merge 35 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
3ebd889
Remove LICENSE file
kromash Jun 4, 2019
47572f7
Make example simple and fast
kromash Jun 12, 2019
1e8e0d4
Merge pull request #71 from MI2DataLab/cran_comments
kromash Jun 12, 2019
d7ad6d9
Add more complex example and update man doc
kromash Jun 14, 2019
e56635b
Fix whitespaces in doc
kromash Jun 14, 2019
3f91b73
Fix typo in an author name
Matiszak Jun 17, 2019
ee6fe43
a bunch of small changes in the paper text
danielskatz Jun 18, 2019
99e6546
Merge pull request #72 from danielskatz/patch-1
Matiszak Jun 25, 2019
bd7a151
bib case fixes
danielskatz Jun 25, 2019
c756f7c
Merge pull request #74 from danielskatz/patch-2
Matiszak Jun 27, 2019
6abf6d0
Add JOSS paper badge
kromash Jun 28, 2019
7eaa11d
Readme badges in single line
kromash Jun 28, 2019
2900cc9
Change badges order
kromash Jun 28, 2019
5cd7fcf
Updated links in README, MI2DataLab -> ModelOriented
pbiecek Aug 26, 2019
cb6dc65
Syntax issue on paragraph 59
kant Sep 2, 2019
b5dbba6
Merge pull request #77 from kant/patch-1
pbiecek Sep 5, 2019
d0a0cb9
Update link to DALEX repository
Nov 25, 2019
1c927d9
Fix modelDown examples
Mar 19, 2020
ab7304d
Remove ceterisParibus2 reference in travis
Mar 19, 2020
3d43676
Merge pull request #80 from ModelOriented/feature/78-update-doc
pbiecek Mar 22, 2020
e8ff482
Merge pull request #82 from ModelOriented/feature/81-fix-examples
pbiecek Mar 22, 2020
2edb9ff
updated links to DOCS and updated function names as in DALEX 1.0
pbiecek Mar 22, 2020
ea9702b
Merge pull request #84 from ModelOriented/feature/83-update-links
kromash Mar 23, 2020
bc99dcb
Change default 'should_open_website' parameter to 'interactive()'
Apr 11, 2020
edd8d84
fix vr.type
kozaka93 Sep 25, 2020
0e2c2b1
add gh-actions
kozaka93 Sep 25, 2020
6237a88
remove tmp file
kozaka93 Sep 25, 2020
2f31427
fix test
kozaka93 Sep 25, 2020
a283bd0
potentail fix for problem with pkgdown
kozaka93 Sep 26, 2020
8ce160f
pkgdown
hbaniecki Sep 26, 2020
5c46ded
updated website
pbiecek Oct 23, 2020
8f15a99
test force pkgdown
hbaniecki Oct 23, 2020
c1f2307
remove website file from master
hbaniecki Oct 23, 2020
a00cb97
initial fix of auditor module
michkam89 Apr 27, 2022
2438d4c
updated auditor generator; changed purrr::map to lapply, added librar…
michkam89 Apr 28, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
^README.md$
^.*\.Rproj$
^\.Rproj\.user$
^misc$
^docs$
^_pkgdown\.yml$
.travis.yml
vignettes/
^paper.bib$
^paper.md$
^cran-comments.md$
paper_images/
scripts/
^\.github$
^.*\.gif
^.*\.png
^pkgdown$
^codecov\.yml$
32 changes: 4 additions & 28 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,28 +1,4 @@
# Set the default behavior, in case people don't have core.autocrlf set.
* text eol=lf
* eol=lf

#
## These files are binary and should be left untouched
#

# (binary is a macro for -text -diff)
*.png binary
*.jpg binary
*.jpeg binary
*.gif binary
*.ico binary
*.mov binary
*.mp4 binary
*.mp3 binary
*.flv binary
*.fla binary
*.swf binary
*.gz binary
*.zip binary
*.7z binary
*.ttf binary
*.eot binary
*.woff binary
*.pyc binary
*.pdf binary
docs/* linguist-documentation
man/* linguist-documentation
misc/* linguist-documentation
pkgdown/* linguist-documentation
1 change: 1 addition & 0 deletions .github/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.html
102 changes: 102 additions & 0 deletions .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# NOTE: This workflow is overkill for most R packages
# check-standard.yaml is likely a better choice
# usethis::use_github_action("check-standard") will install it.
#
# For help debugging build failures open an issue on the RStudio community with the 'github-actions' tag.
# https://community.rstudio.com/new-topic?category=Package%20development&tags=github-actions
on:
push:
branches:
- master
pull_request:
branches:
- master

name: R-CMD-check

jobs:
R-CMD-check:
runs-on: ${{ matrix.config.os }}

name: ${{ matrix.config.os }} (${{ matrix.config.r }})

strategy:
fail-fast: false
matrix:
config:
- {os: macOS-latest, r: 'release'}
- {os: windows-latest, r: 'release'}
- {os: windows-latest, r: '3.6'}
- {os: ubuntu-16.04, r: 'devel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/xenial/latest", http-user-agent: "R/4.0.0 (ubuntu-16.04) R (4.0.0 x86_64-pc-linux-gnu x86_64 linux-gnu) on GitHub Actions" }
- {os: ubuntu-16.04, r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/xenial/latest"}
- {os: ubuntu-16.04, r: 'oldrel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/xenial/latest"}
- {os: ubuntu-16.04, r: '3.5', rspm: "https://packagemanager.rstudio.com/cran/__linux__/xenial/latest"}

env:
R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
RSPM: ${{ matrix.config.rspm }}
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}

steps:
- uses: actions/checkout@v2

- uses: r-lib/actions/setup-r@master
with:
r-version: ${{ matrix.config.r }}
http-user-agent: ${{ matrix.config.http-user-agent }}

- uses: r-lib/actions/setup-pandoc@master

- name: Query dependencies
run: |
install.packages('remotes')
saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
shell: Rscript {0}

- name: Cache R packages
if: runner.os != 'Windows'
uses: actions/cache@v2
with:
path: ${{ env.R_LIBS_USER }}
key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}
restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-

- name: Install system dependencies
if: runner.os == 'Linux'
run: |
while read -r cmd
do
eval sudo $cmd
done < <(Rscript -e 'writeLines(remotes::system_requirements("ubuntu", "16.04"))')

- name: Install dependencies
run: |
remotes::install_deps(dependencies = TRUE)
remotes::install_cran("rcmdcheck")
shell: Rscript {0}

- name: Session info
run: |
options(width = 100)
pkgs <- installed.packages()[, "Package"]
sessioninfo::session_info(pkgs, include_base = TRUE)
shell: Rscript {0}

- name: Check
env:
_R_CHECK_CRAN_INCOMING_: false
run: rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran", "--run-donttest", "--run-dontrun"), error_on = "warning", check_dir = "check")
shell: Rscript {0}

- name: Show testthat output
if: always()
run: find check -name 'testthat.Rout*' -exec cat '{}' \; || true
shell: bash

- name: Upload check results
if: failure()
uses: actions/upload-artifact@main
with:
name: ${{ runner.os }}-r${{ matrix.config.r }}-results
path: check
47 changes: 47 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
on:
push:
branches: master

name: pkgdown

jobs:
pkgdown:
runs-on: macOS-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v2

- uses: r-lib/actions/setup-r@master

- uses: r-lib/actions/setup-pandoc@master

- name: Query dependencies
run: |
install.packages('remotes')
saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
shell: Rscript {0}

- name: Cache R packages
uses: actions/cache@v2
with:
path: ${{ env.R_LIBS_USER }}
key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}
restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-

- name: Install dependencies
run: |
remotes::install_deps(dependencies = TRUE)
install.packages("pkgdown")
remotes::install_github("ModelOriented/DrWhyTemplate")
shell: Rscript {0}

- name: Install package
run: R CMD INSTALL .

- name: Deploy package
run: |
git config --local user.email "[email protected]"
git config --local user.name "GitHub Actions"
Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)'
55 changes: 55 additions & 0 deletions .github/workflows/pr-commands.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
on:
issue_comment:
types: [created]
name: Commands
jobs:
document:
if: startsWith(github.event.comment.body, '/document')
name: document
runs-on: macOS-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v2
- uses: r-lib/actions/pr-fetch@master
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
- uses: r-lib/actions/setup-r@master
- name: Install dependencies
run: Rscript -e 'install.packages(c("remotes", "roxygen2"))' -e 'remotes::install_deps(dependencies = TRUE)'
- name: Document
run: Rscript -e 'roxygen2::roxygenise()'
- name: commit
run: |
git config --local user.email "[email protected]"
git config --local user.name "GitHub Actions"
git add man/\* NAMESPACE
git commit -m 'Document'
- uses: r-lib/actions/pr-push@master
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
style:
if: startsWith(github.event.comment.body, '/style')
name: style
runs-on: macOS-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v2
- uses: r-lib/actions/pr-fetch@master
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
- uses: r-lib/actions/setup-r@master
- name: Install dependencies
run: Rscript -e 'install.packages("styler")'
- name: Style
run: Rscript -e 'styler::style_pkg()'
- name: commit
run: |
git config --local user.email "[email protected]"
git config --local user.name "GitHub Actions"
git add \*.R
git commit -m 'Style'
- uses: r-lib/actions/pr-push@master
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
46 changes: 46 additions & 0 deletions .github/workflows/test-coverage.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
on:
push:
branches:
- master
pull_request:
branches:
- master

name: test-coverage

jobs:
test-coverage:
runs-on: macOS-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v2

- uses: r-lib/actions/setup-r@master

- uses: r-lib/actions/setup-pandoc@master

- name: Query dependencies
run: |
install.packages('remotes')
saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
shell: Rscript {0}

- name: Cache R packages
uses: actions/cache@v2
with:
path: ${{ env.R_LIBS_USER }}
key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}
restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-

- name: Install dependencies
run: |
install.packages(c("remotes"))
remotes::install_deps(dependencies = TRUE)
remotes::install_cran("covr")
shell: Rscript {0}

- name: Test coverage
run: covr::codecov()
shell: Rscript {0}
41 changes: 0 additions & 41 deletions .travis.yml

This file was deleted.

23 changes: 13 additions & 10 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
Package: modelDown
Title: Make Static HTML Website for Predictive Models
Version: 1.0.1
Authors@R: c(person("Przemysław", "Biecek", email = "[email protected]", role = c("aut")),
Version: 1.1.1
Authors@R: c(person("Przemyslaw", "Biecek", email = "[email protected]", role = c("aut")),
person("Magda", "Tatarynowicz", email = "[email protected]", role = c("aut")),
person("Kamil", "Romaszko", email = "[email protected]", role = c("aut", "cre")),
person("Mateusz", "Urbański", email = "[email protected]", role = c("aut")))
person("Mateusz", "Urbanski", email = "[email protected]", role = c("aut")),
person("Michal", "Kaminski", role = c("ctb")))
Description: Website generator with HTML summaries for predictive models.
This package uses 'DALEX' explainers to describe global model behavior.
We can see how well models behave (tabs: Model Performance, Auditor),
Expand All @@ -15,10 +16,10 @@ Description: Website generator with HTML summaries for predictive models.
Work on this package was financially supported by the NCN Opus grant 2017/27/B/ST6/01307
at Warsaw University of Technology, Faculty of Mathematics and Information Science.
Depends: R (>= 3.4.0)
License: Apache License 2.0 | file LICENSE
License: Apache License 2.0
Encoding: UTF-8
LazyData: true
Imports: DALEX (>= 0.2.8),
Imports: DALEX (>= 1.0),
auditor (>= 0.3.0),
ggplot2 (>= 3.1.0),
whisker (>= 0.3-2),
Expand All @@ -30,9 +31,11 @@ Imports: DALEX (>= 0.2.8),
devtools (>= 2.0.1),
breakDown (>= 0.1.6),
drifter (>= 0.2.1)
Suggests: ranger,
Suggests:
ranger,
testthat,
useful
RoxygenNote: 6.1.1
URL: https://github.com/MI2DataLab/modelDown
BugReports: https://github.com/MI2DataLab/modelDown/issues
useful,
covr
RoxygenNote: 7.1.2
URL: https://github.com/ModelOriented/modelDown
BugReports: https://github.com/ModelOriented/modelDown/issues
Loading