Skip to content

Commit 3f1c0c6

Browse files
committed
fix doc
1 parent ac82198 commit 3f1c0c6

File tree

6 files changed

+40
-44
lines changed

6 files changed

+40
-44
lines changed

R/modelStudio.R

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,7 @@
7777
#'
7878
#' # make a studio for the model
7979
#' modelStudio(explainer_titanic,
80-
#' new_observations,
81-
#' N = 200, B = 5) # faster example
80+
#' new_observations)
8281
#'
8382
#' \donttest{
8483
#'

R/ms_update_observations.R

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -41,31 +41,34 @@
4141
#' library("modelStudio")
4242
#'
4343
#' # fit a model
44-
#' model_apartments <- glm(m2.price ~. , data = apartments)
44+
#' model_titanic <- glm(survived ~., data = titanic_imputed, family = "binomial")
4545
#'
4646
#' # create an explainer for the model
47-
#' explainer_apartments <- explain(model_apartments,
48-
#' data = apartments,
49-
#' y = apartments$m2.price)
47+
#' explainer_titanic <- explain(model_titanic,
48+
#' data = titanic_imputed,
49+
#' y = titanic_imputed$survived)
5050
#'
5151
#' # make a studio for the model
52-
#' ms <- modelStudio(explainer_apartments)
53-
#' ms
52+
#' ms <- modelStudio(explainer_titanic)
5453
#'
5554
#' # add new observations
5655
#' ms <- ms_update_observations(ms,
57-
#' explainer_apartments,
58-
#' new_observation = apartments[100:101,],
59-
#' new_observation_y = apartments$m2.price[100:101])
56+
#' explainer_titanic,
57+
#' new_observation = titanic_imputed[100:101,],
58+
#' new_observation_y = titanic_imputed$survived[100:101])
6059
#' ms
6160
#'
61+
#' \donttest{
62+
#'
6263
#' # overwrite the observations with new ones
6364
#' ms <- ms_update_observations(ms,
64-
#' explainer_apartments,
65-
#' new_observation = apartments[100:101,],
65+
#' explainer_titanic,
66+
#' new_observation = titanic_imputed[100:101,],
6667
#' overwrite = TRUE)
6768
#' ms
6869
#'
70+
#' }
71+
#'
6972
#' @export
7073
#' @rdname ms_update_observations
7174
ms_update_observations <- function(object,

R/ms_update_options.R

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,15 @@
3030
#' library("modelStudio")
3131
#'
3232
#' # fit a model
33-
#' model_apartments <- glm(m2.price ~. , data = apartments)
33+
#' model_titanic <- glm(survived ~., data = titanic_imputed, family = "binomial")
3434
#'
3535
#' # create an explainer for the model
36-
#' explainer_apartments <- explain(model_apartments,
37-
#' data = apartments,
38-
#' y = apartments$m2.price)
36+
#' explainer_titanic <- explain(model_titanic,
37+
#' data = titanic_imputed,
38+
#' y = titanic_imputed$survived)
3939
#'
4040
#' # make a studio for the model
41-
#' ms <- modelStudio(explainer_apartments)
42-
#' ms
41+
#' ms <- modelStudio(explainer_titanic)
4342
#'
4443
#' # update the options
4544
#' new_ms <- ms_update_options(ms,

man/modelStudio.Rd

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

man/ms_update_observations.Rd

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

man/ms_update_options.Rd

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

0 commit comments

Comments
 (0)