# jonocarroll/mathpix

Query the mathpix API to convert math images to LaTeX
R
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.

# 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")

## Trial Authentication

I have included a general API key with this package, but misuse of it will result in it being cancelled. There is also a trial API key which can be invoked using the trial = TRUE argument to some functions.

## 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.

If you also wish to generate the images (although rmarkdown will gladly do this for you) this can be achieved using

render_latex(latex, fileDir)

where latex is the LaTeX generated by mathpix() (or any other escaped LaTeX) and fileDir is the (optional) directory where you wish to save the image (by default, a temp file). This requires that you have pdflatex set up correctly and available on your machine.

## Full Authentication

Obtain a Mathpix API key using the Mathpix Dashboard (note that this requires you to accept Mathpix's terms and conditions and sign up for any relevant pricing scheme) then set the following values in your ~/.Renviron file

MATHPIX_APP_ID=yourID
MATHPIX_APP_KEY=yourKEY

## API Documentation

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