12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667 mathjaxr: Using Mathjax in Rd Files =================================== [![R build status](https://github.com/wviechtb/mathjaxr/workflows/R-CMD-check/badge.svg)](https://github.com/wviechtb/mathjaxr/actions) [![CRAN Version](https://www.r-pkg.org/badges/version/mathjaxr)](https://CRAN.R-project.org/package=mathjaxr) ![devel Version](https://img.shields.io/badge/devel-1.4--0-brightgreen.svg) ## Description The mathjaxr package allows for easy inclusion of [MathJax](https://www.mathjax.org/) equations in Rd files. Package authors wanting to make use of the package and its functionality need to: 1. install the mathjaxr package, 2. add mathjaxr to Suggests or Imports in the DESCRIPTION file of their package, 3. add mathjaxr to RdMacros in the DESCRIPTION file of their package (or add RdMacros: mathjaxr if the DESCRIPTION file does not yet contain a RdMacros entry), One can then enable the use of MathJax by calling the \loadmathjax macro (that is provided by the mathjaxr package) within the \description{} section of an Rd file (or within the @description section if you use roxygen2). An inline equation can then be added with the \mjeqn{latex}{ascii} macro, with the LaTeX commands for the equation given between the first set of curly brackets (which will be rendered in the HTML and PDF help pages) and the plain-text version of the equation given between the second set of curly brackets (which will be shown in the plain text help). With the \mjdeqn{latex}{ascii} macro, one can add 'displayed equations' (as in LaTeX's displaymath environment). Single argument versions of these macros, \mjseqn{latexascii} and \mjsdeqn{latexascii}, are also available. For the relatively rare case that one must specify different LaTeX commands for the PDF and HTML pages, there are also triple argument versions of these macros, namely \mjteqn{pdflatex}{htmllatex}{ascii} and \mjtdeqn{pdflatex}{htmllatex}{ascii}. ## Details The Javascript code for MathJax is contained in this package. If a user viewing a help page has mathjaxr installed, it will be retrieved from there, otherwise it will be retrieved from the CDN site https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml-full.js. To force use of the CDN site, the user can set the environment variable MATHJAXR_USECDN to any non-blank value (e.g., Sys.setenv(MATHJAXR_USECDN=TRUE)). The URL for a diferent CDN can be specified via the environment variable MATHJAXR_CDN. Package authors who want to ensure that users can see the rendered equations in the HTML help pages also when offline should add mathjaxr to Imports. To avoid the note from R CMD check that All declared Imports should be used, one can add import(mathjaxr) to NAMESPACE. ## Issues Care must be taken when using the less-than and greater-than symbols in equations as these might get interpreted by the browser as HTML tags. See [here](https://docs.mathjax.org/en/latest/input/tex/html.html) for further details. Adding space around these symbols should solve this problem (e.g., instead of writing \mjseqn{i
where ![\mu](https://render.githubusercontent.com/render/math?math=%5Cmu) denotes the mean of the distribution and ![\sigma](https://render.githubusercontent.com/render/math?math=%5Csigma) its standard deviation. ## Installation The current official (i.e., [CRAN](https://cran.r-project.org/package=mathjaxr)) release can be installed within R with: r install.packages("mathjaxr")  The development version of the package can be installed with: r install.packages("remotes") remotes::install_github("wviechtb/mathjaxr")  This builds the package from source based on the current version on [GitHub](https://github.com/wviechtb/mathjaxr). ## Meta The mathjaxr package is licensed under the [GNU General Public License Version 3](https://www.gnu.org/licenses/gpl-3.0.txt), while MathJax itself is licensed under the [Apache License, Version 2.0](https://github.com/mathjax/MathJax/blob/master/LICENSE). To report any issues or bugs, please go [here](https://github.com/wviechtb/mathjaxr/issues). `