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

Fix up knitr paths relative to the output directory #2502

Merged
merged 11 commits into from
Apr 30, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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: 2 additions & 1 deletion R/rmarkdown.R
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ render_rmarkdown <- function(pkg, input, output, ..., seed = NULL, copy_images =
update_html(
path,
tweak_rmarkdown_html,
input_path = path_dir(input_path),
output_dir = path_dir(output_path),
input_dir = path_dir(input_path),
pkg = pkg
)
}
Expand Down
24 changes: 21 additions & 3 deletions R/tweak-page.R
Original file line number Diff line number Diff line change
Expand Up @@ -37,19 +37,37 @@ tweak_page <- function(html, name, pkg = list(bs_version = 3)) {
}
}

tweak_rmarkdown_html <- function(html, input_path, pkg = list(bs_version = 3)) {
tweak_rmarkdown_html <- function(html, input_dir, output_dir, pkg = list(bs_version = 3)) {
# Tweak classes of navbar
toc <- xml2::xml_find_all(html, ".//div[@id='tocnav']//ul")
xml2::xml_attr(toc, "class") <- "nav nav-pills nav-stacked"

# Make sure all images use relative paths
img <- xml2::xml_find_all(html, "//img")
src <- xml2::xml_attr(img, "src")

# Drop the logo and any inline images
is_ok <- !grepl("^data:", src) & xml2::xml_attr(img, "class", default = "") != "logo"
img <- img[is_ok]
src <- src[is_ok]

# Fix up absoluate paths to be relative to input_dir
abs_src <- is_absolute_path(src)
if (any(abs_src)) {
purrr::walk2(
img[abs_src],
path_rel(src[abs_src], input_path),
path_rel(src[abs_src], input_dir),
xml2::xml_set_attr,
attr = "src"
)
}

# Fix up paths that are relative to input_dir instead of output_dir
input_abs_path <- path_tidy(path(input_dir, src))
up_path <- !abs_src & path_has_parent(input_abs_path, output_dir)
if (any(up_path)) {
purrr::walk2(
img[up_path],
path_rel(path(input_dir, src[up_path]), output_dir),
xml2::xml_set_attr,
attr = "src"
)
Expand Down
2 changes: 1 addition & 1 deletion tests/testthat/test-tweak-page.R
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ test_that("h1 section headings adjusted to h2 (and so on)", {
<h1>2</h1>
</div>
")
tweak_rmarkdown_html(html)
tweak_rmarkdown_html(html, input_dir = ".", output_dir = ".")
expect_equal(xpath_text(html, ".//h1"), "Title")
expect_equal(xpath_text(html, ".//h2"), c("1", "2"))
expect_equal(xpath_text(html, ".//h3"), "1.1")
Expand Down
29 changes: 29 additions & 0 deletions vignettes/img-path.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: "imgpathdebug"
---

```{r}
plot(1:5)
```

```{r}
knitr::include_graphics("test/bacon.jpg")
```

```{r}
# magick:::`knit_print.magick-image`()
magick::image_read("https://jeroen.github.io/images/frink.png")
```

```{r}
library(ggplot2)
library(gganimate)

p <- ggplot(mtcars, aes(factor(cyl), mpg)) +
geom_point() +
# Here comes the gganimate code
transition_states(gear)

animate(p, nframes = 1)
```

Loading