studio principiantes principales para paquetes librería librerias instalados estadistica español r documentation package roxygen2

principiantes - Documentación bilingüe(inglés y portugués) en un paquete R



r para principiantes (2)

Además de la documentación bilingüe, permítame el siguiente comentario: dados sus dos grupos "objetivo", se puede suponer que algunos de sus usuarios ejecutarán sistemas operativos que no estén en inglés (normalmente, Windows en portugués). Al importar datos de series de tiempo (o cualquier entrada de fecha como un hecho), debido al formato diferente de "fecha" (inglés vs. no inglés), puede obtener diferentes "resultados" (es decir, entradas de fecha malinterpretadas) al importar a inglés / Máquinas no inglesas. Tengo algo de experiencia con esos problemas (a menudo trabajo con sistemas operativos basados ​​en el idioma checo) y, aparte de la codificación ad-hoc, no encuentro una solución simple. (Si encuentra este tema fuera de discusión, no dude en eliminarlo)

Estoy escribiendo un paquete para facilitar la importación de conjuntos de microdatos socioeconómicos brasileños (Census, PNAD, etc.). Preveo dos grupos distintos de usuarios del paquete:

  • Usuarios en Brasil, que pueden sentirse más cómodos con la documentación en portugués. Probablemente pueda entender el inglés hasta cierto punto, pero un idioma extranjero probablemente haga que el paquete se sienta menos "ergonómico".

  • La comunidad de usuarios internacionales más amplia, de la cual la documentación en inglés puede ser una condición necesaria.

¿Es posible escribir un paquete de manera que la documentación sea "bilingüe" (inglés y portugués) y que el idioma que se muestra al usuario dependa de la configuración de su país / idioma?

También,

¿Es eso posible dentro del marco de documentación de roxygen2?

Me doy cuenta de que hay un compromiso de hacer que el paquete sea más fácil de usar al hacerlo bilingüe frente a la mayor complejidad y dificultad de mantenimiento. Los comentarios generales sobre esta compensación de la experiencia previa también son bienvenidos.

EDITAR: siguiendo la sugerencia del comentario, publiqué una lista cruzada de r-package-devel mailling. HERE , luego sigue las respuestas en la parte inferior. Duncan Murdoch publicó una respuesta interesante que cubre algo de lo que cubre @ brandons (abajo), pero también incluye dos sugerencias adicionales que creo que son útiles:

  • tener el paquete en un solo idioma, pero las viñetas para diferentes idiomas. Seguiré este consejo.

  • Tiene que tener versiones del paquete, digamos 1.1 y 1.2, una en cada idioma.


Según Ropensci , no existe un mecanismo estándar para traducir la documentación del paquete a Ropensci no Ropensci en inglés. Describen el proceso típico de internationalization/localization siguiente manera:

Para crear documentación que no esté en inglés, se requiere la creación manual de archivos .Rd o viñetas de paquetes adicionales .

Los paquetes que suministran documentación que no está en inglés deben incluir un campo de Idioma en el archivo de DESCRIPTION .

Y algo más de información sobre el campo Language :

Se puede usar un campo ''Idioma'' para indicar si la documentación del paquete no está en inglés: debe ser una lista separada por comas de etiquetas de idioma IETF estándar (sin uso privado o con derechos adquiridos) según lo define actualmente la RFC 5646 ( https://tools.ietf.org/html/rfc5646 , vea también https://en.wikipedia.org/wiki/IETF_language_tag ), es decir, use subetiquetas de idioma que en esencia son ISO 639-1 de dos letras ( https://en.wikipedia.org/wiki/ISO_639-1 ) o 3 letras ISO 639-3 ( https://en.wikipedia.org/wiki/ISO_639-3 ) códigos de idioma.

Es necesario tener cuidado si su paquete contiene texto que no es ASCII, y en particular si está destinado a ser utilizado en más de una localidad. Es posible marcar la codificación utilizada en el archivo de DESCRIPCIÓN y en los archivos .Rd.

Respecto a la codificación ...

Primero, considere cuidadosamente si realmente necesita un texto que no sea ASCII. Muchos usuarios de R solo podrán ver correctamente el texto en su grupo de idioma nativo (por ejemplo, Europa Occidental, Europa del Este, Chino Simplificado) y ASCII.72. Es posible que otros caracteres no se representen en absoluto, se representen de forma incorrecta o que su código R dé un error. Para la documentación .Rd, marcar la codificación e incluir las transliteraciones ASCII es probable que haga un trabajo razonable. El conjunto de caracteres que comúnmente se admite es más amplio de lo que solía ser alrededor de 2000, pero los alfabetos no latinos (griego, ruso, georgiano, ...) son a menudo problemáticos y aquellos con caracteres de doble ancho (chino, japonés, coreano) A menudo se necesitan fuentes especializadas para renderizar correctamente.

Sin embargo, en una nota relacionada, R proporciona soporte para "errores y advertencias" en diferentes idiomas : "Existen mecanismos para traducir los mensajes de error y advertencia de nivel R y C. Solo están disponibles si R se compila con NLS soporte (que se solicita mediante la opción de configuración --enable-nls, el valor predeterminado) ".