Skip to content

Commit 5903974

Browse files
committed
Update documentation
1 parent 19e2def commit 5903974

6 files changed

Lines changed: 14 additions & 0 deletions

File tree

.Rbuildignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,4 @@ cran-comments.md
2121
Report.html
2222
Report.Rmd
2323

24+
^CRAN-SUBMISSION$

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ Report.Rmd
88
cran-comments.md
99
CRAN-RELEASE
1010
docs
11+
^CRAN-SUBMISSION$

NAMESPACE

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Generated by roxygen2: do not edit by hand
22

3+
S3method(generate_chunk,default)
4+
S3method(generate_chunk,funnel_measure)
5+
S3method(generate_chunk,overall_comparison)
6+
S3method(generate_chunk,training_test_comparison)
37
S3method(model_info,GraphLearner)
48
S3method(model_info,H2OBinomialModel)
59
S3method(model_info,H2OMultinomialModel)

R/explain_xgboost.R

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
#'
1515
#'
1616
#' @examples
17+
#' \donttest{
1718
#' library("xgboost")
1819
#' library("DALEXtra")
1920
#' library("mlr")
@@ -26,6 +27,7 @@
2627
#' explainer_1 <- explain_xgboost(model, data = titanic_imputed[,-8],
2728
#' titanic_imputed$survived)
2829
#' plot(predict_parts(explainer_1, titanic_imputed[1,-8]))
30+
#' }
2931
#'
3032
#' @rdname explain_xgboost
3133
#' @export

R/generate_chunk.R

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
generate_chunk <- function(object, output_path, iterator, name)
44
UseMethod("generate_chunk")
55

6+
#' @export
67
generate_chunk.overall_comparison <- function(object, output_path, iterator, name) {
78
con_overall_comparison <- file(system.file("ChampionChallenger", "overall_comparison_section.Rmd", package = "DALEXtra"))
89
lines_overall_comparison <- readLines(con_overall_comparison)
@@ -20,6 +21,7 @@ generate_chunk.overall_comparison <- function(object, output_path, iterator, nam
2021
append = TRUE)
2122
}
2223

24+
#' @export
2325
generate_chunk.training_test_comparison <- function(object, output_path, iterator, name) {
2426
con_training_test_comparison <- file(system.file("ChampionChallenger", "training_test_comparison_section.Rmd", package = "DALEXtra"))
2527
lines_training_test_comparison <- readLines(con_training_test_comparison)
@@ -37,6 +39,7 @@ generate_chunk.training_test_comparison <- function(object, output_path, iterato
3739
append = TRUE)
3840
}
3941

42+
#' @export
4043
generate_chunk.funnel_measure <- function(object, output_path, iterator, name) {
4144
con_funnel_measure <- file(system.file("ChampionChallenger", "funnel_measure_section.Rmd", package = "DALEXtra"))
4245
lines_funnel_measure <- readLines(con_funnel_measure)
@@ -55,6 +58,7 @@ generate_chunk.funnel_measure <- function(object, output_path, iterator, name) {
5558

5659
}
5760

61+
#' @export
5862
generate_chunk.default <- function(object, output_path, iterator, name) {
5963
if(is.null(name) | name == "") {
6064
name <- class(object)[1]

man/explain_xgboost.Rd

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)