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

Add caption and label for htmlwidgets #118

Closed
byzheng opened this issue May 18, 2016 · 6 comments
Closed

Add caption and label for htmlwidgets #118

byzheng opened this issue May 18, 2016 · 6 comments
Milestone

Comments

@byzheng
Copy link

byzheng commented May 18, 2016

Is it possible to add legend and label for htmlwidgets chucks? I have added some DiagrammeR figures in my book. It will be really nice we can have a legend and cross reference it.

@yihui
Copy link
Member

yihui commented May 18, 2016

I guess you mean "caption" instead of legend. If that is the case, yes, figure captions and labels are supported, but only when the widgets are rendered as screenshots. You can see Section 2.8 of the PDF version of the bookdown book https://bookdown.org/yihui/bookdown/

@byzheng
Copy link
Author

byzheng commented May 18, 2016

is it possible to support html output?

@yihui
Copy link
Member

yihui commented May 18, 2016

Currently it is not supported, but I can consider it in the near future.

@byzheng
Copy link
Author

byzheng commented May 18, 2016

Thanks for your consideration.

@yihui yihui changed the title Add legend and label for htmlwidgets Add caption and label for htmlwidgets Jul 10, 2016
@yihui yihui modified the milestone: v0.2 Jul 12, 2016
@yihui
Copy link
Member

yihui commented Oct 1, 2016

Done. You can install the development versions of bookdown and knitr via

devtools::install_github('rstudio/bookdown')

cc @cpsievert

yihui added a commit to yihui/knitr that referenced this issue Oct 4, 2016
jsonn pushed a commit to jsonn/pkgsrc that referenced this issue Mar 11, 2017
Upstream changes:

CHANGES IN knitr VERSION 1.15.1

@yihui yihui released this on 23 Nov 2016 · 49 commits to master since this release
NEW FEATURES

    added a new hook function hook_pngquant() that can call pngquant to optimize PNG images (thanks, @slowkow, #1320)

BUG FIXES

    not really a knitr bug, but knit_params() should be better at dealing with multibyte characters now due to the bug fix in the yaml package vubiostat/r-yaml#6

Downloads

    Source code (zip)
    Source code (tar.gz)

    v1.15
    b08a7bc

CHANGES IN knitr VERSION 1.15

@yihui yihui released this on 10 Nov 2016 · 63 commits to master since this release
NEW FEATURES

    NA values can be displayed using different characters (including empty strings) in kable(); you can set the option knitr.kable.NA, e.g. options(knitr.kable.NA = '') to hide NA values (#1283)
    added a fortran95 engine (thanks, @stefanedwards, #1282)
    added a block2 engine for R Markdown documents as an alternative to the block engine; it should be faster and supports arbitrary Pandoc's Markdown syntax, but it is essentially a hack; note when the output format is LaTeX/PDF, you have to define \let\BeginKnitrBlock\begin \let\EndKnitrBlock\end in the LaTeX preamble
    figure captions specified in the chunk option fig.cap are also applied to HTML widgets (thanks, @byzheng, rstudio/bookdown#118)
    when the chunk option fig.show = 'animate' and ffmpeg.format = 'gif', a GIF animation of the plots in the chunk will be generated for HTML output (https://twitter.com/thomasp85/status/785800003436421120)
    added a width argument to write_bib() so long lines in bib entries can be wrapped
    the inline syntax r#code is also supported besides r code; this can make sure the inline expression is not split when the line is wrapped (thanks, Dave Jarvis)
    provided a global R option knitr.use.cwd so users can choose to evaluate the R code chunks in the current working directory after setting options(knitr.use.cwd = TRUE); the default is to evaluate code in the directory of the input document, unless the knitr option opts_knit$set(root.dir = ...) has been set
    if options(knitr.digits.signif = TRUE), numbers from inline expressions will be formatted using getOption('digits') as the number of significant digits, otherwise (the default behavior) getOption('digits') is treated as the number of decimal places (thanks, @numatt, #1053)
    the chunk option engine.path can also be a list of paths to the engine executables now, e.g., you can set knitr::opts_chunk$set(engine.path = list(python = '/anaconda/bin/python', perl = '/usr/local/bin/perl')), then when a python code chunk is executed, /anaconda/bin/python will be called instead of the system default (rstudio/rmarkdown#812)
    introduced a mechanism to protect text output in the sense that it will not be touched by Pandoc during the conversion from R Markdown to another format; this is primarily for package developers to extend R Markdown; see ?raw_output for details (which also shows new functions extract_raw_output() and restore_raw_output())

MAJOR CHANGES

    the minimal version of R required for knitr is 3.1.0 now (#1269)
    the formatR package is an optional package since the default chunk option tidy = FALSE has been there for a long time; if you use tidy = TRUE, you need to install formatR separately if it is not installed
    :set +m is no longer automatically added to haskell code chunks (#1274)

MINOR CHANGES

    the package option opts_knit$get('stop_on_error') has been removed
    the confusing warning message about knitr::knit2html() when buiding package vignettes using the knitr::rmarkdown engine without pandoc/pandoc-citeproc has been removed (#1286)
    the default value of the quiet argument of plot_crop() was changed from !opts_knit$get('progress') to TRUE, i.e., by default the messages from cropping images are suppressed

BUG FIXES

    the chunk option cache.vars did not really behave like what was documented (thanks, @simonKTH, #1280)
    asis_output() should not be merged with normal character output when results='hold' (thanks, @kevinushey, #1310)

Downloads

    Source code (zip)
    Source code (tar.gz)

    v1.14
    b34be0d

CHANGES IN knitr VERSION 1.14

@yihui yihui released this on 12 Aug 2016 · 845 commits to master since this release
NEW FEATURES

    improved caching for Rcpp code chunks: the shared library built from the C++ code will be preserved on disk and reloaded the next time if caching is enabled (chunk option cache = TRUE), so that the exported R functions are still usable in later R code chunks; note this feature requires Rcpp >= 0.12.5.6 (thanks, @jjallaire, #1239)
    added a helper function all_rcpp_labels(), which is simply all_labels(engine == 'Rcpp') and can be used to extract all chunk lables of Rcpp chunks
    added a new engine named sql that uses the DBI package to execute SQL queries, and optionally assign the result to a variable in the knitr session; see http://rmarkdown.rstudio.com/authoring_knitr_engines.html for details (#1241)
    fig.keep now accepts numeric values to index low-level plots to keep (#1265)

BUG FIXES

    fixed #1211: pandoc('foo.md') generates foo_utf8.html instead of foo.html by default
    fixed #1236: include = FALSE for code chunks inside blockquotes did not work (should return > instead of a blank line) (thanks, @fmichonneau)
    fixed #1217: define the command \hlipl for syntax highlighting for Rnw documents (thanks, @conjugateprior)
    fixed #1215: restoring par() settings might fail when the plot window is partitioned, e.g. par(mfrow = c(1, 2)) (thanks, @jrwishart @jmichaelgilbert)
    fixed #1250: in the quiet mode, knit() should not emit the message "processing file ..." when processing child documents (thanks, @KZARCA)

MAJOR CHANGES

    knitr will no longer generate screenshots automatically for HTML widgets if the webshot package or PhantomJS is not installed

MINOR CHANGES

    if dev = 'cairo_pdf', the cairo_pdf device will be used to record plots (previously the pdf device was used) (#1235)
    LaTeX short captions now go up to the first ., : or ; character followed by a space or newline (thanks, @knokknok, #1249)
@github-actions
Copy link

github-actions bot commented Nov 6, 2020

This old thread has been automatically locked. If you think you have found something related to this, please open a new issue by following the issue guide (https://yihui.org/issue/), and link to this old issue if necessary.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 6, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants