example - roxygen2 documentation data

Vinculación a otros paquetes en la documentación en roxygen2 en R

Question

Me pregunto si existe un método para link a la función de otro paquete cuando estoy tratando de escribir una documentación para un nuevo paquete utilizando roxygen2 . Algo como /link{pck=PACKAGE_NAME, fun=FUNCTION_NAME} ?

Answer 1

Esta es ahora una pregunta bastante antigua, pero para cualquier persona que encuentre su camino aquí más recientemente, puede encontrar algunas de las guías de formato más útiles en la hoja de referencia de Hadley, y todos los detalles de las etiquetas disponibles here .

Tenga en cuenta que el segundo enlace describe los comandos de marcado subyacentes, por lo que en roxygen2 reemplaza el / con un @ y también no hay necesidad de llaves. Por ejemplo, /details{My package does some awesome things} convierte en @details My package does some awesome things .

Además, en Rstudio, si comienzas una línea con #'' puedes presionar tab y aparecerán todas las etiquetas disponibles.

Answer 2

Tienes que escribir /link[pkg]{function} por ejemplo /link[stringi]{stri_c}