Skip to content

roxygen2 & markdown & math

6 messages · Wolfgang Viechtbauer, Sigbert Klinke, Jeff Newmiller +2 more

Original
Sigbert Klinke
# 
Hi,

I like to make my package documentation with markdown which is supported 
since roxygen2 6.0.0 . I used a math expression like $t_n \appox N(0,1)$ 
which leads in the package check to "unknown macro '\approx'".

I guess I get the warning because math is not supported in markdown. Are 
there any plans to support something like $...$ or $$...$$? Or there are 
general problems?

Best Sigbert
Wolfgang Viechtbauer
# 
Dear Sigbert,

The mathjaxr package provides this:

https://cran.r-project.org/package=mathjaxr
https://github.com/wviechtb/mathjaxr

Best,
Wolfgang
Sigbert Klinke
# 
Hi,

thanks a lot, but maybe I was to vague.

I do not want to replace \eqn{...} and \deqn{...} by \mjseqn{...} and 
\mjsdeqn{...}. I would like to use $...$ and $$...$$ as in Rmarkdown to 
get something better readable.

Best Sigbert

Am 12.01.21 um 10:41 schrieb Viechtbauer, Wolfgang (SP):

  
    
  


  


      

    

    

      
      

        


  

        

      Jeff Newmiller
    

    

      
      #
    

  


  

      
a) This discussion is on the wrong mailing list. Please go to R-package-devel if you want to continue this discussion.

b) You can do whatever you want in your vignettes, but R doc files are designed to work with multiple output devices, including text-only terminals, so syntax specific to certain environments is not allowed. If you want to contribute improvements to R doc capabilities, I am sure patches will be considered as long as you adhere to the existing multi-platform constraints.

        
On January 12, 2021 10:12:51 AM PST, Sigbert Klinke <sigbert at wiwi.hu-berlin.de> wrote:

            

      
      
      
    

        

  
    

      
      
    

  


  


      

    

    

      
      

        


  

        

      Duncan Murdoch
    

    

      
      #
    

  


  

      
On 12/01/2021 1:12 p.m., Sigbert Klinke wrote:

            

      
      
      
    

        
I think that's a question/suggestion that would have to go to the 
roxygen2 team.  They're the ones who convert Markdown into the Rd input 
format.  Presumably they could convert $...$ into the appropriate macro 
using Mathjax or not, but I have no idea how difficult that would be.

Duncan Murdoch

            

      
      
      
    

  
  


  


      

    

    
1 day later

    

      
      

        


  

        

      Hadley Wickham
    

    

      
      #
    

  


  

      
On Tuesday, January 12, 2021, Duncan Murdoch <murdoch.duncan at gmail.com>
wrote:

            

      
      
      
    

        
If I remember correctly, I think it would be relatively hard since roxygen2
uses commonmark, which doesn?t include math in its parse tree. It might be
possible to hack something together with regular expressions, but of course
that brings with it the risk of introducing new edge cases that don?t
behave as expected.

Hadley