lifecycle badge image not found on quarto site

[rbcavanaugh]

If I have the following in my function roxygen2 documentation

#' Creates a temporary table from a local data frame or tibble
#'
#' `r lifecycle::badge('experimental')`

I get the following on the generated reference page for the function:

(link to function: https://github.com/roux-ohdsi/allofus/blob/main/R/aou_temp_tables.R and site: https://roux-ohdsi.github.io/allofus/man/aou_create_temp_table.html)

[etiennebacher]

I see, the link correctly appears in the qmd file but it links to the badge that is located in man/figures and this badge is not imported in the docs folder.

[vincentarelbundock]

Can we swap the lifecycle line with some kind of conditional link? It feels silly to import another package and build complicated backend code just to insert an image and a link in the docs...

[etiennebacher]

IIUC we wouldn't have to import lifecycle, we would just need to copy all the SVG badges from man/figures (I guess those are created by devtools::document()) to docs/man/figures. We don't have to use any functionalities from lifecycle itself

[vincentarelbundock]

I was thinking there must exist a one-liner to load an image from a website without altdoc having to do anything at all.

But I've not tried to find one yet...

[vincentarelbundock]

If that one-line doesn't exist or is too complicated, we should support a more general interface to inserting images in documentation.

I just think we should resist the temptation to replicate every possible tidyverse functionality with dedicated arguments and backend code, and try to think of more general ways to do things.

[eitsupi]

Does this have anything to do with tidyverse?
This actually generates the following Rd code, which has no package dependencies.
I infer from this that the \figure tag is for linking to images in man/figures (i.e., a specification in the Rd file that has nothing to do with the tidyverse).

\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}}

See also: https://rstudio.github.io/r-manuals/r-exts/Writing-R-documentation-files.html#figures

The files containing the figures should be stored in the directory man/figures. Files with extensions .jpg, .jpeg, .pdf, .png and .svg from that directory will be copied to the help/figures directory at install time. (Figures in PDF format will not display in most HTML browsers, but might be the best choice in reference manuals.) Specify the filename relative to man/figures in the \figure directive.

man/figures seems to be commonly used to put files related to images.
https://github.com/search?q=org%3Acran%20path%3Aman%2Ffigures&type=code

Related to r-lib/pkgdown#1787

[eitsupi]

pkgdown's example:
https://github.com/r-lib/pkgdown/blob/0cb9d38d1dc25946f01ee7500be9665985d8784e/R/build-reference.R#L200-L208
https://github.com/r-lib/pkgdown/blob/0cb9d38d1dc25946f01ee7500be9665985d8784e/R/tweak-tags.R#L90-L107

postdoc's example:
https://github.com/ropensci/postdoc/blob/29aefc38076ca170eeaa81caca72606a2088e8e4/R/manual.R#L129-L142

[eitsupi]

Apparently, image handling in the R package is more cumbersome than one might imagine.

Images in man/figures will be moved to help/figures after installation, so the Rd2HTML() function will use the relative path ../help/figures for the \figure tag of Rd files.

pkgdown copies all normal images to reference/figures/ and rewrites all tags of HTML files.

Only the logo is specially copied to the top level.
https://github.com/r-lib/pkgdown/blob/0cb9d38d1dc25946f01ee7500be9665985d8784e/R/build-logo.R

The easiest workaround is to copy man/figures to help/figures as well, but in this case, if there are references to man/figures from README, etc., the same image will exist in two places. (This may not be a big problem, just a waste of space.)

Perhaps a process needs to be added to rewrite the links to help/figures to man/figures for html files.