Cross-referencing tables generated by RStudio Preview version

dano · October 6, 2020, 3:58pm

Loving the new visual markdown editor feature in RStudio preview release (1.4.869). The table editor is really useful for quickly generating text-heavy tables. I'm struggling to cross reference the simple tables generated by RStudio though. Here's a sample output generated by RStudio: when I knit this it correctly generates the table caption and numbers the table accordingly. But, I can't figure out how to then cross reference that generated table, e.g. what would normally be "See Table.\@ref(tab:my-table)" when the table is generated in a chunk with name "my-table". Since the table is being numbered correctly it seems like it must be possible?

| Col1 | Col2 | Col3 |
|------|------|------|
|    a  |    b  |    c  |
|   d   |    e  |   f   |
|    g  |   h   |   i   |

Table: Test

cderv · October 6, 2020, 4:44pm

You can write this

---
title: Referencing table
output: bookdown::html_document2
---

| Col1 | Col2 | Col3 |
|------|------|------|
| a    | b    | c    |
| d    | e    | f    |
| g    | h    | i    |

: (\#tab:test) A caption Test

See table \@ref(tab:test)

You need to use a bookdown format to make the referencing work. See https://rstudio.github.io/visual-markdown-editing/#/technical?id=cross-references

The key is using (\#tab:label) in source mode or (#tab:label) in visual editor mode so thate the reference is found.

dano · October 6, 2020, 5:31pm

Thanks for the quick reply, I can confirm that that solves it when knitting to pdf, word, and html using bookdown

Seems like this would be good to add to the bookdown documentation, particularly given the likely increase in these kinds of tables that the visual editor will create, I can take a stab at one

cderv · October 7, 2020, 8:52am

Where exactly do you suggest to add something ?

cderv · October 7, 2020, 8:55am

I suppose here:

github.com/rstudio/bookdown

Suggested edit to simple table cross-referencing documentation

opened 06:00PM - 06 Oct 20 UTC

DanOvando

book documentation

Given the new interactive table generator in the RStudio preview visual markdown… editor, it seems like those sorts of simple tables might get an uptick in use (I find them really handy for generating text-heavy tables, as opposed to trying to shoehorn the content into a dataframe and passing to knitr::kable) I found the cross-referencing documentation for these types of tables to be a little confusing though. I would suggest something like this instead (this could be updated once the visual markdown editor becomes part of the standard RStudio release to reflect the format created by the interactive table generator?) Pandoc supports several types of [Markdown tables,](http://pandoc.org/MANUAL.html#tables) such as simple tables, multiline tables, grid tables, and pipe tables. You can write your own simple table directly in markdown like this: ```markdown Table:(\#tab:simple-table) A simple table in Markdown. Sepal.Length Sepal.Width Petal.Length Petal.Width ------------- ------------ ------------- ------------ 5.1 3.5 1.4 0.2 4.9 3.0 1.4 0.2 4.7 3.2 1.3 0.2 4.6 3.1 1.5 0.2 5.0 3.6 1.4 0.2 5.4 3.9 1.7 0.4 ``` Which will produce this table when the document is knit Table:(\#tab:simple-table) A simple table in Markdown. Sepal.Length Sepal.Width Petal.Length Petal.Width ------------- ------------ ------------- ------------ 5.1 3.5 1.4 0.2 4.9 3.0 1.4 0.2 4.7 3.2 1.3 0.2 4.6 3.1 1.5 0.2 5.0 3.6 1.4 0.2 5.4 3.9 1.7 0.4 You can then cross-reference this simple table using `\@ref(tab:simple-table)`, creating Table.\@ref(tab:simple-table). https://github.com/rstudio/bookdown/blob/74c8bef593c9c365c4d44680d0c0c470c7e38170/inst/examples/02-components.Rmd#L556

system · October 14, 2020, 8:55am

This topic was automatically closed 7 days after the last reply. New replies are no longer allowed.

If you have a query related to it or one of the replies, start a new topic and refer back with a link.