inline code chunks for foreign engine

[rcst]

I have posted this question on SO.

I've written a knitr engine to process Maxima code (as part of a package), which works for "regular" chunks just fine, e.g.:

```{maxima}
1+1;
```

results in

(%i1) 1+1;

# (%o1) 2

However, when I try to get the output printed inline, such as

`maxima 1+1;`

It gets printed literally: maxima 1+1;

The R Markdown Cookbook explicitly says

inline: processing output from inline R expressions.

Questions

So I guess this is not meant be working (yet)? Is there a workaround? What parts of knitr should I touch, if I wanted to implement it?

---

By filing an issue to this repo, I promise that

• [x] I have fully read the issue guide at https://yihui.org/issue/.
• [x] I have provided the necessary information about my issue.
  • If I'm asking a question, I have already asked it on Stack Overflow or RStudio Community, waited for at least 24 hours, and included a link to my question there.
  • If I'm filing a bug report, I have included a minimal, self-contained, and reproducible example, and have also included xfun::session_info('knitr'). I have upgraded all my packages to their latest versions (e.g., R, RStudio, and R packages), and also tried the development version: remotes::install_github('yihui/knitr').
  • If I have posted the same issue elsewhere, I have also mentioned it in this issue.
• [x] I have learned the Github Markdown syntax, and formatted my issue correctly.

I understand that my issue may be closed if I don't fulfill my promises.

[atusy]

I've been thought about this before. I concluded the syntax like `maxima 1+1;` is not a good idea because addition of engines certainly make authors difficult to distinguish which inline code need the evaluation.

If I were to implement, I'd implement `1+1;`{maxima} which is more consistent with the syntax of chunk and may allow additional chunk options.

About the current implementation,

• pattern matching happens at https://github.com/yihui/knitr/blob/3237add034368a3018ff26fa9f4d0ca89a4afd78/R/pattern.R#L34
• evaluation happens at https://github.com/yihui/knitr/blob/3237add034368a3018ff26fa9f4d0ca89a4afd78/R/hooks.R#L13

[yihui]

I agree with @atusy. I tend not to generalize the syntax `r ` to other engines. I'm not totally comfortable with the syntax for inline expressions since it's not unique enough. People might write literal code like `r = sqrt(x^2 + y^2)`, which doesn't mean inline R code. If I generalize the syntax to other languages, the potential ambiguity can bite users harder.

Is there a workaround?

I don't know anything about the rim package you mentioned. If it provides a way to access maxima variables or run maxima code from the R session, your problem would be solved. The reticulate package is a good example, e.g., you can use reticulate::py to access Python objects. However, you mentioned that rim::maxima.get() uses a different maxima session: https://stackoverflow.com/questions/68283952/knitr-inline-code-chunk-of-foreign-engine#comment120684378_68283952 Then perhaps there isn't a workaround.

[vorpalvorpal]

If I were to implement, I'd implement `1+1;`{maxima} which is more consistent with the syntax of chunk and may allow additional chunk options.

More consistent with both the current syntax and the chunk syntax would be `{engine_name} foo`. If this were introduced, `r foo` could then become a shortcut for `{r} foo`.

[atusy]

`{engine_name} foo` is interesting. However, I still say `foo`{engine_name} because this syntax is more consistent with Pandoc's inline code with attributes (e.g., `knitr::knit(x)`{.r})

[rcst]

Thanks for your suggestions. I solved this issue by implementing a wrapper maxima.inline() that accesses the Maxima session used for the knitr-engine. So the user can do

`r maxima.inline("1+1;")`

I think that's sufficient for this issue.