JuliaInterop / JuliaCall

Embed Julia in R
https://non-contradiction.github.io/JuliaCall/index.html
Other
267 stars 36 forks source link

Documenting difference between `julia_call`, `julia_eval`, `julia_command` #92

Closed aguang closed 5 years ago

aguang commented 5 years ago

Would you be able to document somewhere the difference between julia_call, julia_eval, and julia_command? In particular the difference between these functions in returning a value to R and returning a value to Julia.

It took me a while to understand that julia_command does not return a value to R, but will display return values from Julia (if show_value=TRUE) while julia_eval will not display return values from Julia but will return a value to R (if need_return %in% c("R","Julia")) while julia_call can do either/both.

aguang commented 5 years ago

Linking to openjournals/joss-reviews#1284

Non-Contradiction commented 5 years ago

The difference is already documented. However, when I look at it again, the wording is not that clear. And other users have also asked me questions about these functions. So I think I need to improve the documentation and make it more clear. Thanks for the suggestion.

Non-Contradiction commented 5 years ago

Documentation about these functions has been improved, and it can be retrieved by ?julia_eval and ?julia_command.

aguang commented 5 years ago

Looks good to me. Thanks!