README.md

In jonocarroll/mathpix: Support for the 'Mathpix' API (Image to 'LaTeX')

mathpix

Installation:

mathpix is now on CRAN, so you can install using

install.packages("mathpix")

If you’re after newer development features (if there are any); you can install from GitHub using

devtools::install_github("jonocarroll/mathpix")

Authentication

The free API key has been removed due to overuse. Please sign up at https://dashboard.mathpix.com/ then save your ID and key in your .Renviron file as

MATHPIX_APP_ID='yourid'
MATHPIX_APP_KEY='yourkey'

Note that this requires you to accept Mathpix’s terms and conditions and sign up for any relevant pricing scheme.

You can check that your credentials are loaded correctly with credentials().

Usage

If you have an image you would rather properly encode in LaTeX, for example

then simply calling

mathpix("./integral.jpg")

(with the appropriate path to the file) will insert a LaTeX block into your document which will render what the image represents

$$
 \int \frac { 4 x } { \sqrt { x ^ { 2 } + 1 } } d x  
$$

which renders to

Even complicated, hand-drawn figures work

mathpix("matrix_3x3.jpg")

$$
 A = \left( \begin{array} { l l l } { 2 } & { 7 } & { 3 } \\ { 3 } & { 5 } & { 2 } \\ { 9 } & { 4 } & { 1 } \\ \end{array} \right)  
$$

If your image only result in warnings and no LaTeX, use retry = TRUE to attempt some pre-processing of the image into a more amenable form. Unfortunately, there are still images which fail.

To not insert the resulting equation directly into your document, but rather store it in a variable, use insert = FALSE.

API Documentation

Refer to http://docs.mathpix.com/

jonocarroll/mathpix documentation built on Nov. 7, 2023, 2:38 p.m.