Skip to content

docs: route README plots via github.com raw path #29

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.

Sign up for GitHub

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

Merged
ielbadisy merged 2 commits into from
Apr 20, 2026
Merged

docs: route README plots via github.com raw path #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5db92bb
docs: route README plot links via github.com raw path
ielbadisy Apr 20, 2026
68b8e6d
merge main into PR branch and keep github raw README image links
ielbadisy Apr 20, 2026
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
3 changes: 3 additions & 0 deletions README.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ knitr::opts_chunk$set(
warning = FALSE,
message = FALSE
)
knitr::opts_knit$set(
base.url = "https://github.com/ielbadisy/funcml/raw/main/"
)
pkgload::load_all(".", export_all = FALSE, helpers = FALSE, quiet = TRUE)
ggplot2::theme_set(theme_funcml())
set.seed(42)
Expand Down
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ eval_obj
plot(eval_obj)
```

![](man/figures/README-evaluate-plot-1.png)<!-- -->
![](https://github.com/ielbadisy/funcml/raw/main/man/figures/README-evaluate-plot-1.png)<!-- -->

`funcml` also supports grouped cross-validation, time-based resampling,
and holdout validation through `group_cv()`, `time_cv()`, and
Expand Down Expand Up @@ -324,7 +324,7 @@ tune_obj
plot(tune_obj)
```

![](man/figures/README-tune-plot-1.png)<!-- -->
![](https://github.com/ielbadisy/funcml/raw/main/man/figures/README-tune-plot-1.png)<!-- -->

## Compare learners

Expand Down Expand Up @@ -363,7 +363,7 @@ compare_obj
plot(compare_obj)
```

![](man/figures/README-compare-plot-1.png)<!-- -->
![](https://github.com/ielbadisy/funcml/raw/main/man/figures/README-compare-plot-1.png)<!-- -->

## Interpret fitted models

Expand Down Expand Up @@ -392,7 +392,7 @@ summary(permute_obj)
plot(permute_obj)
```

![](man/figures/README-interpret-permute-plot-1.png)<!-- -->
![](https://github.com/ielbadisy/funcml/raw/main/man/figures/README-interpret-permute-plot-1.png)<!-- -->

A second example shows accumulated local effects for one feature from
the same fitted model.
Expand All @@ -409,7 +409,7 @@ ale_obj <- interpret(
plot(ale_obj)
```

![](man/figures/README-interpret-ale-1.png)<!-- -->
![](https://github.com/ielbadisy/funcml/raw/main/man/figures/README-interpret-ale-1.png)<!-- -->

Other supported methods include PDP, ICE, SHAP, local explanations,
surrogate models, interaction diagnostics, and calibration plots.
Expand All @@ -432,7 +432,7 @@ calibration_obj <- interpret(
plot(calibration_obj)
```

![](man/figures/README-calibration-1.png)<!-- -->
![](https://github.com/ielbadisy/funcml/raw/main/man/figures/README-calibration-1.png)<!-- -->

## Estimate causal effects

Expand Down Expand Up @@ -463,7 +463,7 @@ est_obj
plot(est_obj)
```

![](man/figures/README-estimate-plot-1.png)<!-- -->
![](https://github.com/ielbadisy/funcml/raw/main/man/figures/README-estimate-plot-1.png)<!-- -->

The same interface also supports `ATT`, `CATE`, and `IATE`.

Expand Down
Loading