Language documentation for a package

Hi, I hope this is the right place to post this question.
We are preparing some packages in my work (meteorological data with agrometeorological index calculations and soil data) and we would like to send them for review to rOpenSci.
To be able to send it, does the package documentation have to be in English? (our native language is Spanish).
Thank you!

1 Like

Hi Yanina.
This is definitely the right place to ask.
We have talked a bit about this kind of issue. I’ll bring this to the software review editors’ attention and make sure we come back with a clear answer.

Thank you for asking

1 Like

Hello Yanina! Thanks for reaching out. We are eager to review packages in more languages and are open to packages with Spanish documentation and to conducting the peer-review process in Spanish, as well. This will be a first, however, so please have some patience as we experiment a some along the way, both in getting appropriate reviewers and considering if there are any language-specific review standards we should implement.

I’d suggest submitting one Spanish language package for us to review at first so we can figure out the process. When you submit, please make a note in the submission issue if (1) documentation is in a non-English language, and (2) if you’d prefer a Spanish review process.

One thing we should think about in this is whether to use R’s tools for language localization in messages/errors, too. We have one example in our collection of a package that does this: Rpolyhedra. It’s actually not too complicated, but the documentation for localization is a bit hard to follow. The msgtools package that provides some helpers but is no longer maintained.

2 Likes

Thank you so much for your reply. This allow us to write our documentation in our native language. And thanks for the pointers about messages/errors.

We will continue this process as you explain here as soon as we have a package ready to send to review.

Yani

1 Like

Don’t hesitate to ask further questions!