Code Monkey home page Code Monkey logo

Comments (2)

psycaroly avatar psycaroly commented on May 25, 2024 1

Hi and thank you for taking the time to consider this feature! :) As it is mainly an issue of readability, I do not think that placing a tag instead of showing the rmarkdown-syntax would help.

In my particular use case, my collaborator is familiar with rmarkdown, so they would have no problem understanding the citations / footnote syntax. Instead, it really is a case of not having a smooth reading experience with non-evaluated citations / footnotes and thus providing feedback becomes more burdensome if you have to have two files open simultaneously, one to read and one to comment.

Maybe this is a style-thing, but although I write all my papers in rmarkdown, I always perform the "check of how does it read" in an evaluated/knitted version (e.g., pdf or word), and not in the rmarkdown file itself.

So, if it wouldn't make too much trouble to evaluate citations and footnotes, that would surely improve the experience I personally have with trackdown and the chances that I get collaborators to cooperate ;-)

from trackdown.

ClaudioZandonella avatar ClaudioZandonella commented on May 25, 2024

Hi @CaroZygar,

Sorry for the late reply.

I have tried to figure out how Rmarkdown manages citations and footnotes. I was hoping for some kind of already available functions to evaluate citations and footnotes separately from the whole document. Actually, everything is managed by Pandoc.

To my understanding (that I admit is pretty limited, as each time I dig into rmarkdown/knitr source code I end up with little more than a huge headache๐Ÿ˜…; I really admire the complexity of these packages), there is no shortcut for evaluating citations and footnotes other than using Pandoc. Now, Pandoc is a little bit too far for me. I have very limited experience using Pandoc directly. Moreover, managing citations is quite complex (many options, settings and possible scenarios). On top of this, there would still be the problem of how to manage backward evaluation to restore the original document.

At the moment, I do not see any easy solutions to evaluate citations and footnotes without evaluating the whole document. For the reasons discussed in the previous comment (link), the idea beyond trackdown is to not evaluate the document to keep the workflow as simple as possible. Instead, to enhance readability, we can hide/restore code chunks and other parts. As you pointed out, however, placing a tag instead of showing the rmarkdown-syntax would not help in the case of citations and footnotes (apart from avoiding other collaborators inadvertently editing the code).

Unfortunately, I can't think of other solutions. I will leave the issue open. Maybe, someone will find a possible solution in the future.

from trackdown.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.