rstudio / rstudio/rticles

Add cross-referencing to all rticles

Open
#328 7 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
TeX
Stars
1.5k
Forks
517
Avg merge
1d 8h
Merged PRs (30d)
5

Description

I think that it could be easier to use cross-referencing in rticles. References to tables, figures and equations are ubiquitous to scientific papers. bookdown provides a generic solution that, I think, is more likely to bring users to success from the start.

\begin{equation}
(\#eq:eq)
c = a \cdot b
\end{equation}
  
see \@ref(eq:eq)

Gives
image

@cderv suggested that maybe we could provide two possible default outputs in the skeletons. Something like:

output:
  rmarkdown::pdf_document:
    base_format: rticles::mdpi_article
  bookdown::pdf_book: 
    base_format: rticles::mdpi_article

It has the benefit that the default output does not require bookdown, and it shows that other outputs are possible. While cross-referencing would not work from the start, enabling it would be a matter of picking the next output in the list. If using bookdown as the default output is excluded, then I think this solution is pretty good.

Following #327, I believe that the solution might need to be applied to all skeletons.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the output YAML and the repository's article skeletons referenced in the issue, then compare how each skeleton defines its default output. Check the proposed alternative output behavior and determine whether cross-references work consistently across all skeletons. Done means every skeleton has a documented, usable path to cross-referencing without making bookdown mandatory by default.

Written by the indexing model from the issue text.

Assessment

Tech stack
latex, markdown, r
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.