Title

XLSTAT: Implementación de una función R simple en Excel usando XLSTAT-R

Answer

XLSTAT: Implementación de una función R simple en Excel usando XLSTAT-R

Este articulo muestra los pasos para implementar una función R simple en Excel utilizando el motor XLSTAT-R.
Para que XLSTAT-R funcione en su entorno XLSTAT, consulte este articulo .

Cómo hacer que la regresión basada en rangos esté disponible en Excel - XLSTAT

Para este articulo, elegimos trabajar con la función rfit del paquete {Rfit}. Permite estimar coeficientes basados en rangos para modelos lineales. Se considera que esas estimaciones son más robustas con respecto a los valores atípicos en comparación con los enfoques de estimación más clásicos.
Como entrada de datos, rfit busca:

Una variable dependiente cuantitativa
Variables independientes (explicativas) cualitativas o cuantitativas

También añadiremos la posibilidad de mostrar un gráfico de barras que represente los coeficientes de regresión. Utilizaremos el motor de gráficos XLSTAT.

Paso 1: Abra una plantilla XML y complete la Estructura del método

Las funciones de XLSTAT-R están escritas en código XML. Hay disponible una documentación detallada sobre la sintaxis XML de XLSTAT-R aquí . El código XML completo vinculado a este articulo se puede encontrar en la parte superior derecha de esta página. Para comenzar a desarrollar nuestra función, necesitamos abrir una plantilla XML de XLSTAT-R. Haga clic en R / Abrir una plantilla XML .

La plantilla se abre en su editor XML predeterminado con la ruta especificada en las opciones de XLSTAT, pestaña XLSTAT-R . Sin embargo, recomendamos encarecidamente editar sus archivos XML, utilizando Sublime (Windows y Mac) o Notepad++ (solo Windows).
Tenga en cuenta que también es posible iniciar su proyecto de función a partir de una función existente. Esto puede ser útil cuando la función que desea desarrollar tiene una estructura de entrada o salida similar a una que ya se ha desarrollado en XLSTAT-R. Simplemente explore las funciones existentes generalmente almacenadas en esta dirección: %AppData%\ADDINSOFT\XLSTAT\XLSTAT-R\groups
Ahora es el momento de completar los atributos vinculados a la estructura del método . La estructura del método es la raíz de su proyecto de función XLSTAT-R. Aquí, debe definir atributos importantes como el nombre de su función, la estructura de datos de entrada, las bibliotecas R que utilizará, etc. Para completar los atributos del método y los subnodos, reemplace los textos de la plantilla entre las comillas.

Complete los atributos de la siguiente manera:

text="Regresión basada en rango". Este es el nombre de su función.
datastructure="model". Esta estructura incluye datos que se fusionarán en una fórmula R. Esto es típico de las funciones R que incluyen variables dependientes y variables independientes o predictores. Este es el caso de la función rfit. Para estructuras de datos regulares, simplemente ingrese "datos".
function="rfit". Este es el nombre de la función principal de R que está implementando o de su propio procedimiento.
group="Rfit". Este será el submenú en el que se almacenará su función en el menú XLSTAT-R. También será el nombre de la carpeta en la que guardará su proyecto XML.
packages="Rfit". Incluya aquí la lista de paquetes que se deben cargar para que su función funcione. Si necesita incluir varios paquetes, sepárelos con comas. Por ejemplo, si desea incluir el paquete plotrix para poder generar gráficos R con barras de error, escriba packages="Rfit,plotrix".
family="Modelado lineal robusto". Atributo opcional.
pregunta="¿Cómo puedo obtener estimaciones robustas del modelo lineal?". Atributo opcional.
sinónimos="Regresión robusta". Atributo opcional.

Complete los subnodos del método de la siguiente manera: - <AuthorXML>John Smith</AuthorXML>

<AuthorRFunction>John Kloke</AuthorRFunction>. Ingrese ?rfit en R para averiguar el nombre del autor.
<CompatibilityXLSTAT>19.5</CompatibilityXLSTAT>. La versión de XLSTAT con la que está desarrollando la función. Puede encontrarla haciendo clic en XLSTAT / Acerca de XLSTAT a la derecha de la cinta.
<CompatibilityR>3.4.2</CompatibilityR>. La versión de R que estás usando. Puedes encontrarla al abrir la consola de R.
<Fecha de creación>29 de septiembre de 2017</Fecha de creación>
<DateModified>2017.09.29</DateModified>. Asegúrate de actualizar esta fecha cada vez que publiques una nueva modificación en tu función.
<PackageVersion>rfit 0.23.0</PackageVersion>. Puede encontrarlo cargando los paquetes en su consola R y ejecutando el comando sessionInfo(). Si tiene varios paquetes, sepárelos con punto y coma (por ejemplo, rfit 0.23.0; plotrix 3.6-6).
<RDescription>Minimiza la función de dispersión de Jaeckel para obtener una solución basada en rangos para modelos lineales.</RDescription>. Incluye las descripciones que aparecen en la sección Descripción de las páginas de ayuda de las funciones R.

Paso 2: Guarda tu plantilla XML

Localice su directorio de trabajo XLSTAT-R\groups. Generalmente se encuentra en %AppData%\ADDINSOFT\XLSTAT\XLSTAT-R\groups
Cree una carpeta Rfit y guarde su plantilla XML como rfit.xlm. La carpeta debe coincidir con el atributo de grupo de métodos y el nombre del archivo XML debe coincidir con el atributo de función del método .
Durante todo el proceso de desarrollo, le recomendamos encarecidamente que verifique cómo evoluciona su proyecto dentro de la interfaz XLSTAT-R. Para hacer esto: 1. Guarde su plantilla
2. Abra XLSTAT, vaya al menú R y haga clic en Actualizar.

3. Abra su función dentro del menú R.

Paso 3: Determinar qué incluir en la interfaz de usuario

Descubriendo las entradas

La primera pregunta que uno puede hacerse aquí es ¿qué entradas incluir en la interfaz de usuario de XLSTAT-R (es decir, el cuadro de diálogo)? Para un proyecto tan simple como este, decidimos usar los argumentos de la función R como entradas. Echemos un vistazo a estos argumentos. Abra la consola R, cargue la biblioteca Rfit y la ayuda de la función rfit escribiendo las siguientes líneas de comando:
> library(Rfit)
> ?rfit
En la documentación de ayuda, en la sección Uso, encontrará la función con los principales argumentos asociados y una explicación del significado de cada argumento:
rfit(formula, data, subset, yhat0 = NULL, scores = Rfit::wscores, synchronous = FALSE, TAU = "F0", ...)
En este articulo, ingresaremos datos que XLSTAT fusionará automáticamente en una fórmula R gracias a la estructura de datos del modelo dentro del motor XLSTAT-R. También permitiremos que el usuario manipule el argumento booleano simétrico , así como el argumento TAU .

Decidir qué pestañas incluir

La interfaz de usuario (es decir, el cuadro de diálogo) se configura en la sección . La interfaz de usuario está organizada en pestañas . Aquí decidimos incluir la estructura de pestañas clásica del cuadro de diálogo de XLSTAT: General , Opciones , Faltantes , Salidas y Gráficos .

Paso 4: Configurar la pestaña General

Comenzamos configurando la pestaña General . En esta pestaña, principalmente queremos incluir: - Una entrada de variable dependiente cuantitativa;

Entradas de variables explicativas cuantitativas;
Entradas de variables explicativas cualitativas;
Opcionalmente, etiquetas de observación.

Para configurar un campo de entrada de datos, se puede utilizar el nodo DataField general. Sin embargo, XLSTAT-R tiene nodos especiales para tratar con datos que se deben fusionar en una fórmula R. Estos nodos tienen la ventaja de permitir al usuario configurar los términos e interacciones que se incluirán en la fórmula mediante un cuadro de diálogo de apuntar y hacer clic. Usaremos estos nodos especiales.
La pestaña se inicia utilizando el siguiente código:
<Tab text="#General" >
Aquí usamos el signo # ya que la cadena General se traduce a varios idiomas en XLSTAT. El código XML buscará la cadena dentro del diccionario XLSTAT y la mostrará en el cuadro de diálogo con el idioma configurado en XLSTAT.
Escriba el siguiente código:
<YQuantiField text="Variable dependiente" controltip="Seleccione su variable dependiente" rname="data" />
<Spacer height="2" />
<XQuantiField rname="data" option="true" optiondefault="true" />
<XQualiField rname="data" option="true" optiondefault="false" />- YQuantiField es el nodo especial de XLSTAT-R que configura un campo para selecciones de variables dependientes cuantitativas. El atributo text establece el título que aparecerá en el cuadro de diálogo. El atributo controltip establece la sugerencia que aparece cuando el usuario pasa el mouse sobre el campo. El atributo rname establece el marco de datos R en el que se almacenarán los datos capturados.

El espaciador es un nodo que se utiliza para separar los elementos del cuadro de diálogo entre sí. El atributo de altura se establece en píxeles.
XQuantiField y XQualifield son los nodos especiales de XLSTAT-R que configuran campos para variables explicativas cuantitativas y cualitativas que se incluirán en la fórmula R. Incluyen valores de atributo de texto predeterminados. El atributo opcional agrega una casilla de verificación al campo para que sea opcional. El atributo optiondefault establece el valor predeterminado para la casilla de verificación.

Así es como se ve la interfaz de usuario en este punto:

Ahora es el momento de configurar la segunda parte de la pestaña General. Escriba el siguiente código:
<NextColumn />
<VarHeaders text="Variable labels" />
<Spacer height="10" />
<ObsLabelsField rname="data" />
<Spacer height="6" />
</Tab>- NextColumn permite cambiar al lado derecho del cuadro de diálogo dentro de la pestaña actual.

VarHeaders es una casilla de verificación XLSTAT típica que indica si los nombres de variables se capturan o no durante la selección de datos.
ObsLabelsField es también un campo de datos XLSTAT típico en el que el usuario puede seleccionar nombres de filas o de observaciones. Aquí, las etiquetas capturadas se introducirán como tales dentro del objeto de datos R.
</Tab> cierra la configuración de la pestaña General .

Aquí está la pestaña General completada:

Es hora de configurar la pestaña Opciones ahora.

Paso 5: Configurar la pestaña Opciones

Aquí decidimos incluir un control sobre las interacciones que el usuario desea incluir en el modelo rfit, así como los argumentos simétricos y TAU . - Simétrico es un argumento booleano (VERDADERO o FALSO). La mejor forma de ingresar este tipo de datos es dibujar una casilla de verificación .

TAU puede tomar un valor de una lista limitada de valores. En este caso, sería adecuado utilizar un cuadro combinado.

<Tab text="#Options" >
<Interactions reportgroup="1" />
<CheckBox text="Symmetric" name="SymmetricAnalysis" rname="symmetric" default="false" reportgroup="2" />
<Spacer height="6" />
<ComboBox text="Routine" name="Routine" rname="TAU" default="0" left="55" width="100" reportgroup="3" >
<Item text="Fortran" rname="F0" />
<Item text="R" rname="R" />
<Item text="None" rname="N" />
</ComboBox>
<Spacer height="6" />
</Tab>- Interacciones es un nodo XLSTAT preconfigurado especial que permite al usuario seleccionar el nivel de interacciones en el modelo dentro del cuadro de diálogo principal. Después de hacer clic en Aceptar, otro cuadro de diálogo permite al usuario seleccionar las interacciones específicas que se incluirán. El atributo opcional reportgroup simplemente incluye esta entrada en el resumen de configuración dentro del informe de resultados. El nivel de interacciones será el primer elemento "1" que se incluirá en la lista de resumen de configuración.

El nodo de argumento simétrico CheckBox incluye varios atributos. name es el nombre interno de XLSTAT-R. rname es el objeto R en el que se almacenará la entrada. default es el valor predeterminado de la casilla de verificación. De manera predeterminada, esta casilla de verificación producirá un objeto R llamado symmetric y que contiene el valor FALSE.
El nodo Combobox que establece el valor del argumento TAU R incluye elementos como miembros. Cada elemento contiene un elemento de la lista de posibles elementos del argumento. Dentro de cada elemento, el atributo text establece el texto que se mostrará en el combobox. El atributo rname contiene el valor que se almacenará dentro del objeto TAU si se selecciona el elemento. El atributo default dentro del nodo ComboBox contiene el índice del elemento que se usará de manera predeterminada. Este índice comienza en 0. En este caso, el valor predeterminado será "F0". left establece la cantidad de píxeles en los que se debe mover el control hacia la izquierda. width define el ancho del control en píxeles.

Paso 6: Configurar la pestaña Datos faltantes

Mantenemos la configuración predeterminada de pestañas faltantes dentro de la plantilla XML. Esas son opciones especiales de XLSTAT para manejar datos faltantes. Para obtener más información, consulte la

Paso 7: Configuración de las pestañas de Resultados y Gráficos

En este articulo, proponemos mantener el código XML de las pestañas de resultados y gráficos tal como están en la plantilla original. Esto generará automáticamente opciones de casillas de verificación dentro de las pestañas según lo especificado en la sección ESPECIFICACIÓN DE RESULTADOS PARA MOSTRAR EN EXCEL (paso 9).
A continuación se muestra el código:

<Tab text="#Outputs" >
<AutoOutputs stats="true" />
</Tab>

<Tab text="#Charts" >
<AutoCharts />
</Tab>
En el nodo AutoOutputs, el atributo stats define si el motor XLSTAT debe calcular y mostrar estadísticas descriptivas sobre los datos capturados.
Antes de pasar a la sección de configuración del informe de resultados (es decir, la especificación de los resultados que se mostrarán en Excel ), proponemos saltar a la sección de código R en la parte inferior de la plantilla XML. Una vez que el código esté configurado, volveremos a la configuración de resultados.

Paso 8: Escritura del código R

Selección de los resultados del análisis que se mostrarán en las salidas

El formato de objeto R más sencillo que XLSTAT-R puede mostrar como resultado es data frames . Echemos un vistazo a un resultado rfit básico para comprobar cómo podríamos extraer un data frame de él.
Abra una consola R y vuelva a la sección de ayuda de rfit. Copie y pegue el código en la sección de Ejemplos en la parte inferior.
> library(Rfit)
> ?rfit
> data(baseball)
> data(wscores)
> fit<-rfit(weight~height,data=baseball)
> summary(fit)
Llamada:
rfit.default(formula = weight ~ height, data = baseball)

Coeficientes: Estimación Error estándar Valor t Valor p (Intersección) -228,57144 56,14659 -4,0710 0,000146 ***altura 5,71429 0,76018 7,5171 4,373e-10 ***

Códigos significativos: 0 '***' 0,001 '**' 0,01 '*' 0,05 '.' 0,1 ' ' 1
Prueba de Wald general: 56,50621 Valor p: 0

Parece que vale la pena mostrar la tabla de coeficientes, ya que incluye tanto las estimaciones (primera columna) como los valores p asociados (última columna).
Veamos cómo podríamos extraer esta tabla específica. Sugerencia: la función names() a menudo ayuda a verificar los elementos que puede extraer de los objetos complejos de R.
> names(summary(fit))
[1] "coefficients" "waldstat" "waldpval" "overall.test" "call"
Tal vez el elemento de coeficientes contenga lo que estamos buscando.
> summary(fit)$coefficients
Estimate Std. Error t.value p.value
(Intercept) -228.571442 56.1465857 -4.070977 1.459710e-04
height 5.714286 0.7601755 7.517061 4.373127e-10
¡Éxito!
Verifiquemos si esto corresponde a un marco de datos:
> is.data.frame(summary(fit)$coefficients)
[1] FALSO No es el caso.
En consecuencia, la siguiente transformación será necesaria en algún punto del código:
> as.data.frame(summary(fit)$coefficients)

Redactar el código: algunas notas preliminares

La escritura del código R se realiza normalmente en la última sección de la plantilla XML (CÓDIGO R), bajo el nodo RScript. El nodo RScript incluye subnodos ScriptLine en los que puede insertar líneas de comandos R.
Hay dos formas de escribir código R en XLSTAT-R. Puede cambiar de una a otra utilizando el atributo booleano replacebyvalue en el nodo RScript. - replacebyvalue="true": XLSTAT-R reemplaza automáticamente los nombres rname que se encuentran en el código XML por sus valores siempre que se los invoque en ScriptLines y si el atributo replace en ScriptLines está configurado como verdadero. Este método es adecuado siempre que desee programar rápidamente funciones de XLSTAT-R que imiten funciones R. Presenta limitaciones si desea manipular objetos R dentro de un código R más complejo con el objetivo de producir más resultados.

replacebyvalue="false": XLSTAT-R almacena automáticamente las entradas del cuadro de diálogo en objetos R, lo que permite una manipulación más flexible en el código R.

En este articulo, utilizaremos el primer método para escribir código R en plantillas XLSTAT-R.

Escribiendo el código usando replacebyvalue="true"

Escriba el siguiente código:
<RScript replacebyvalue="true" >
<ScriptLine replace="true" code="results=rfit(formula,data,symmetric,TAU)" />
<ScriptLine replace="true" code="results$CoefficientsDataFrame=as.data.frame(summary(results)$coefficients)" />
</RScript>
Hay dos líneas de script. La primera llama a la función R rfit. El objeto de fórmula es generado automáticamente por XLSTAT gracias a la estructura de datos del modelo . Con el método replacebyvalue="true", todos los elementos incluidos después son reemplazados por sus valores ingresados en el cuadro de diálogo cada vez que se ejecuta el cuadro de diálogo.
En el archivo XML, los resultados de R que se mostrarán deben almacenarse dentro de un objeto de resultados. Es por eso que creamos el objeto de resultados en la primera línea y el subobjeto CoefficientsDataFrame dentro del objeto de resultados.
A continuación se muestra un script R típico generado con este código. Este script se genera automáticamente en el directorio de trabajo de XLSTAT-R cada vez que ejecuta la función en XLSTAT. Es probable que el archivo de script se encuentre aquí: %AppData%\ADDINSOFT\XLSTAT\XLSTAT-R\datastore\Rfitresults\rfit.script.R > list.of.packages <- c('Rfit')

> nuevos.paquetes<-lista.de.paquetes[!(lista.de.paquetes %in% paquetes.instalados()[,'Paquete'])]

> if(length(nuevos.paquetes)) install.paquetes(nuevos.paquetes, repos='http://cran.us.r-project.org')

> biblioteca('Rfit');

> datos<-read.csv(archivo='%AppData%/ADDINSOFT/XLSTAT/XLSTAT-R/datastore/data.csv', encabezado=TRUE, sep=';', dec='.')

> resultados<-rfit(peso ~ +altura,datos,simétrico=FALSO,TAU='F0')

> resultados$CoeficientesDataFrame<-as.data.frame(summary(resultados)$coeficientes)

> escribir.tabla(resultados$CoeficientesDataFrame, archivo = %AppData%/ADDINSOFT/XLSTAT/XLSTAT-R/datastore/Rfitresults/CoeficientesDataFrame.csv', na='', fila.nombres =TRUE, cita=FALSO, sep=';', dec=',')

Eche un vistazo a la línea de comando rfit() y vea cómo los elementos se han reemplazado automáticamente.

Paso 9: Configuración de la visualización de resultados en Excel

Ahora es el momento de volver a la sección de configuración del informe de resultados (es decir, la especificación de los resultados que se mostrarán en Excel ). Esta sección incluye el nodo RResults. Incluye tantos subnodos de resultados como resultados haya para mostrar en los resultados.
Inserte el siguiente código:
<RResults>

</RResults>- texto : establece el título del resultado en las salidas;

rname : el elemento del objeto de resultados a mostrar, normalmente un marco de datos;
tipo : tipo de datos almacenados en los elementos rname;
rowlabels : las etiquetas de fila de resultados que se mostrarán. Si se configura en rdesc, se utilizan las etiquetas de fila del objeto R;
collabels : las etiquetas de las columnas de resultados que se mostrarán. Si se configura en rdesc, se utilizan las etiquetas de las columnas del objeto R;
chartname (opcional): el nombre del gráfico que se mostrará, en función de este resultado;
charttype : el tipo de gráfico que se mostrará (consulte la documentación para conocer las posibilidades y los detalles). barchart(0/1) mostrará un gráfico de barras. El cero (0) significa que las etiquetas de fila de la tabla se utilizarán como etiquetas de barra y el uno (1) significa que la primera columna se utilizará como datos para mostrar (estimaciones de coeficientes).

Este código mostrará la tabla de coeficientes, así como un gráfico de barras XLSTAT básico de los coeficientes.
Definitivamente es posible producir un gráfico equivalente en R, utilizando el siguiente código en su lugar:
<RResults>
<Result text="Coefficients" rname="CoefficientsDataFrame" type="double" rowlabels="rdesc" collabels="rdesc" chartname="Gráfico de coeficientes, estilo R" charttype="r" rplotformat="emf" rplotcode="barplot(results$CoefficientsDataFrame[,1], names.arg=row.names(results$CoefficientsDataFrame), ylab='Estimates', xlab='Coefficients',main='Gráfico de barras de coeficientes')" />
</RResults>
Verifique ahora la pestaña Resultados y gráficos . Las casillas de verificación de resultados han aparecido automáticamente:

En la parte inferior del archivo XML, no olvide cerrar la estructura del método utilizando el código a continuación:
</Method>

Paso 10 ¡Disfruta usando tu nueva función en XLSTAT!

Aquí se muestran algunas capturas de pantalla de la función ejecutada en XLSTAT. Descargue el conjunto de datos en la parte superior derecha de la página. Abra R / Rfit / Rank-Based Regression

Rellene la pestaña general de la siguiente manera:

Active la opción Interacciones en la pestaña Opciones

. Haga clic en Aceptar .
En el cuadro de diálogo que aparece, seleccione los términos que desea incluir en el modelo:

Seleccione los términos que desea conservar y haga clic en Aceptar .
Interprete los resultados.