Skip to content

Commit aec6791

Browse files
committed
pass a package name argument to get the docs right for adjacent pkgs
1 parent f522f8f commit aec6791

File tree

4 files changed

+25
-18
lines changed

4 files changed

+25
-18
lines changed

R/aaa_models.R

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -563,7 +563,7 @@ set_model_arg <- function(model, eng, parsnip, original, func, has_submodel) {
563563
#' @rdname set_new_model
564564
#' @keywords internal
565565
#' @export
566-
set_dependency <- function(model, eng, pkg) {
566+
set_dependency <- function(model, eng, pkg= "parsnip") {
567567
check_model_exists(model)
568568
check_eng_val(eng)
569569
check_pkg_val(pkg)
@@ -969,6 +969,7 @@ get_encoding <- function(model) {
969969
#' populates the list seen in "See Also" below. See the details section.
970970
#'
971971
#' @param mod A character string for the model file (e.g. "linear_reg")
972+
#' @param pkg A character string for the pacakge where the funciton is invoked.
972973
#' @return
973974
#' `make_engine_list()` returns a character string that creates a
974975
#' bulleted list of links to more specific help files.
@@ -1010,7 +1011,7 @@ get_encoding <- function(model) {
10101011
#' @examples
10111012
#' find_engine_files("linear_reg")
10121013
#' cat(make_engine_list("linear_reg"))
1013-
find_engine_files <- function(mod) {
1014+
find_engine_files <- function(mod, pkg = "parsnip") {
10141015

10151016
# Get available topics
10161017
topic_names <- search_for_engine_docs(mod)
@@ -1030,16 +1031,16 @@ find_engine_files <- function(mod) {
10301031
eng <- eng[order(eng$.order),]
10311032

10321033
# Determine and label default engine
1033-
default <- get_default_engine(mod)
1034+
default <- get_default_engine(mod, pkg)
10341035
eng$default <- ifelse(eng$engine == default, " (default)", "")
10351036

10361037
eng
10371038
}
10381039

10391040
#' @export
10401041
#' @rdname doc-tools
1041-
make_engine_list <- function(mod) {
1042-
eng <- find_engine_files(mod)
1042+
make_engine_list <- function(mod, pkg = "parsnip") {
1043+
eng <- find_engine_files(mod, pkg)
10431044

10441045
res <-
10451046
glue::glue(" \\item \\code{\\link[=|eng$topic|]{|eng$engine|} |eng$default| }",
@@ -1049,24 +1050,28 @@ make_engine_list <- function(mod) {
10491050
res
10501051
}
10511052

1052-
get_default_engine <- function(mod) {
1053-
cl <- rlang::call2(mod, .ns = "parsnip")
1053+
get_default_engine <- function(mod, pkg= "parsnip") {
1054+
cl <- rlang::call2(mod, .ns = pkg)
10541055
rlang::eval_tidy(cl)$engine
10551056
}
10561057

10571058
#' @export
10581059
#' @rdname doc-tools
1059-
make_seealso_list <- function(mod) {
1060-
eng <- find_engine_files(mod)
1060+
make_seealso_list <- function(mod, pkg= "parsnip") {
1061+
eng <- find_engine_files(mod, pkg)
10611062

10621063
res <-
10631064
glue::glue("\\code{\\link[=|eng$topic|]{|eng$engine| engine details}}",
10641065
.open = "|", .close = "|")
10651066

1066-
main <- c("\\code{\\link[=fit.model_spec]{fit.model_spec()}}",
1067-
"\\code{\\link[=set_engine]{set_engine()}}",
1068-
"\\code{\\link[=update]{update()}}"
1069-
)
1067+
if (pkg == "parsnip") {
1068+
main <- c("\\code{\\link[=fit.model_spec]{fit.model_spec()}}",
1069+
"\\code{\\link[=set_engine]{set_engine()}}",
1070+
"\\code{\\link[=update]{update()}}"
1071+
)
1072+
} else {
1073+
main <- NULL
1074+
}
10701075
paste0(c(main, res), collapse = ", ")
10711076
}
10721077

man/doc-tools.Rd

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

man/extract-parsnip.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/set_new_model.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)