Hello, may I get any help with this question? Thank you so much!

from officedown.

sure,

Function knitr::include_graphics() is part of package 'knitr', not 'officedown'. I am afraid I can't do anything for modifying include_graphics()

from officedown.

Thanks @davidgohel!

Got it. So is there any other way to keep the original height/width ratio when importing a figure?

I like the officedown package and I'm using it to draft the thesis, which contains a large amount of figures...

from officedown.

It is probably easy with only magick::image_read().

Why not using the classical way that works well?

I just tried and without using include_graphics() but usual markdown, it works as expected:

---
output: officedown::rdocx_document
---

```{r setup, include=FALSE}
library(officer)
library(officedown)
```

![](zzz.png)

from officedown.

For future readers

knitr::include_graphics is not part of officedown but knitr. There is nothing to do with package officedown.

Users should use the Markdown syntax to insert images in a markdown document. (note : this does not apply only to officedown format but to all Markdown format),

![caption](path/to/image)

from officedown.

Thank you very much for your advice, @davidgohel.

The classical way of Markdown can insert the figure as its original height/width ratio. May I ask, can it be auto-numbered and cross-referenced?

I also tried magick::image_read(). This can be auto-numbered, but officedown still change the ratio:

---
output: officedown::rdocx_document
---

```{r setup, include=FALSE}
library(officer)
library(officedown)
library(magick)
```

![The result of MAE](figures/mae and test - update.png

```{r mae, fig.cap="MAE"}
mae <- image_read('figures/mae and test - update.png')
mae
```

from officedown.

Captions are simple paragraphs. Use markdown or use what is documented in the manual:

https://ardata-fr.github.io/officeverse/officedown-for-word.html#custom-cross-reference

from officedown.

I asked a similar question here and used magick its not pretty put it does work for projects that require it.

from officedown.

@alapo why don't you use the markdown tag for image? It respects dimensions.

The SO you linked is about changing graph dimensions so that it fills a page. Here the question is how to embed an external image in a word document and keep the aspect ratio without specifying the dimensions.

I think the answer is to simply use markdown tag for image.

from officedown.

@davidgohel I am unsure. The document in the SO question is for a scientific publication...as far as I am aware if you use the markdown tag it would mean that you cannot reference the image in text. In order to convert from pixel information using magick::image_info you would need to specify the dpi/resolution. Apologies for the comment.

from officedown.

The SO question is not about adding a caption but maximizing the dimensions in a Word page:

(I don't understand why people want to write PNG on disk and insert it in the rmarkdown just after... Why not using the classic way, i.e. print a graph, use chunk options and benefit of captions/cross-ref and many options...)

A caption is a paragraph, inserted before or after an element (an image here).

If you use officedown or officer, you can create a caption that can be cross-referenced with officer::block_caption().

from officedown.

Thanks for your advice @davidgohel.

Sometimes, making figures for publication can involve a large amount of code (computation), especially when mapping or setting complicated ashthetics. If we print them directly, the rendering of the document is time-consuming.

In addition, the fig.height and fig.width settings of the code chunk are not always working appropriately for the rendering output. That is, a suitable setting for the code chunk output may become unsuitable in the rendering Word document. This situation often happens when the figure is large or with multiple panels. I also encountered this problem when using bookdown.

Therefore, it might be easier to save the figure as a fixed PNG or JPEG then inserted it back.

from officedown.

OK, thanks for the explanation. I think I understand now.

1. You don't want output graphics with the classical way (you should see caching options, it could help a lot), so you generated graphics in images. But these graphics need captions and should be cross-referencable.
2. In the same time, you want a similar rendering between the word output and what you are seeing in the R Markdown view (probably in RStudio), Word is a paged support and HTML (the R Markdown editor) has different behavior.

For 1:

---
title: "test"
output: officedown::rdocx_document
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = FALSE)
library(officedown)
library(officer)

z <- run_autonum(seq_id = "fig", pre_label = "Fig ",
                 tnd = 1, bkm = "")

```

# An example

```{r}
block_caption("blah",
  style = "Image Caption",
  autonum = set_autonum_bookmark(z, bkm = "fig1")
)
```

![hey hey](zz.png)

# Another example

```{r}
block_caption("blah blah",
  style = "Image Caption",
  autonum = set_autonum_bookmark(z, bkm = "fig2")
)
```

![ho ho](zz.png)

## Reference

This cross ref fig1 : \@ref(fig:fig1)

This cross ref fig1 : \@ref(fig:fig2)

For 2:

Unless you can show a reproducible example, I think fig.height and fig.width are working as expected. If you want to declare an issue, you should always come with a reproducible example. R Markdown editor (visual or not) is not a WYSIWYG interface.

You need to consider HTML and Word are 2 different formats. Word has a maximum width, this does not affect display in R Markdown viewer that is HTML. If your Word doc has a 7 inches' width, figures' width should not exceed that width because they won't be resized as in a Web browser.

I think you are making the assumption that formats should all behave the same, but it's not the case. If you want an HTML 'paged' format, I highly recommend package pagedown. If you need to stick to Word format, you'll have to live with its characteristics.

from officedown.

Got it. This works perfectly on my side. Thank you so much for your kind guidance, @davidgohel. I really appreciate that!

from officedown.