spsspkg.helper Función (R)

spsspkg.helper(folder, helpfile = "markdown.html"). Muestra un archivo HTML en el navegador predeterminado. Está pensado principalmente para visualizar la ayuda de sintaxis de comandos para un comando de extensión que se implementa en R.

• El argumento carpeta es el nombre de la carpeta que contiene el archivo HTML. El argumento debe estar entre comillas y la carpeta especificada debe estar en la raíz de una ubicación en la vía de acceso de biblioteca R, tal como especifica .libPaths().
• El argumento opcional helpfile especifica el nombre del archivo HTML. El valor predeterminado es markdown.html. El archivo HTML debe estar en la raíz de la carpeta especificada.

Si está creando un mandato de extensión en R y está distribuyendo el mandato con un paquete de extensión, incluya el archivo de ayuda HTML para el mandato en el paquete de extensión. Cuando se instala el paquete de extensión, el archivo HTML se instala con los otros archivos para el paquete de extensión y se encuentra automáticamente en la raíz de una carpeta que está en la vía de acceso de biblioteca R. Además, si utiliza el nombre predeterminado de markdown.html, el archivo de ayuda se visualiza cuando los usuarios pulsan F1 en el editor de sintaxis cuando el cursor está situado dentro del mandato.

Los ejemplos de uso de la función spsspkg.helper se pueden encontrar en el código de implementación para los comandos de extensión instalados con IBM® SPSS® Statistics. El código de implementación (archivos de código fuente R) se puede encontrar en la ubicación donde se instalan los mandatos de extensión en el sistema. Para ver la ubicación, ejecute el comando de sintaxis SHOW EXTPATHS. La salida muestra una lista de ubicaciones bajo el encabezado "Ubicaciones de comandos de extensión". Los archivos se instalan en la primera ubicación disponible de la lista.