fraping-doc

newDataFrap

# Función: newDataFrap
#
# Descripción: Crear una nueva instancia de la clase "frapclass".
#
# Parámetros:
#   - name: Nombre del objeto FRAP.
#   - bleach: Porcentaje de fotoblanqueo de la muestra.
#
# Retorna: Una instancia de la clase "frapclass".
#
# Uso:
#   frap_obj <- newDataFrap(name, bleach)
A <- newDataFrap("Neurites", 80)
B <- newDataFrap("Secondary.Neurites", 80)
C <- newDataFrap("Dendrites", 80)

plotRecover

# Función: plotRecover
#
# Descripción: Graficar las curvas de recuperación de fluorescencia.
#
# Parámetros:
#   - ...: Parámetros adicionales para la función de gráfico.
#   - index: Índice o índices de los objetos FRAP a graficar.
#   - type: Tipo de curva de recuperación a graficar (por defecto: "RCB").
#   - area: Incluir normalización por área en el gráfico (por defecto: TRUE).
#   - stand: Estandarizar la curva de recuperación (por defecto: TRUE).
#   - AB: Incluir únicamente la fase de recuperación de la curva (por defecto: FALSE).
#   - new.plot: Crear un nuevo gráfico (por defecto: TRUE).
#   - plot.lines: Graficar líneas (por defecto: FALSE).
#   - plot.points: Graficar puntos (por defecto: FALSE).
#   - plot.shadow: Graficar áreas sombreadas (por defecto: FALSE).
#   - plot.mean: Graficar la curva media (por defecto: FALSE).
#   - col: Color de las curvas (por defecto: NULL).
#   - getGroup: Devolver la información del grupo (por defecto: FALSE).
#
# Uso:
#   plotRecover(..., index = NA, type = "RCB", area = TRUE, stand = TRUE, AB = FALSE,
#               new.plot = TRUE, plot.lines = FALSE, plot.points = FALSE, plot.shadow = FALSE,
#               plot.mean = FALSE, col = NULL, getGroup = FALSE)
# Ejemplo 1: Graficar curvas de recuperación de fluorescencia para los objetos A, B y C.
plotRecover(A, B, C, plot.lines = TRUE, col = c("blue", "red", "green"))

# Ejemplo 2: Graficar índices específicos de las curvas de recuperación.
plotRecover(A, B, C, index = c(1, 3), plot.points = TRUE, col = "purple")

# Ejemplo 3: Personalizar el gráfico con áreas sombreadas y curva media.
plotRecover(A, B, C, plot.lines = TRUE, plot.shadow = TRUE, plot.mean = TRUE)

# Ejemplo 4: Graficar curvas de recuperación estandarizadas sin normalización por área.
plotRecover(A, B, C, area = FALSE, stand = TRUE, plot.lines = TRUE, col = "orange")

# Ejemplo 5: Graficar curvas de recuperación de diferentes objetos FRAP en el mismo gráfico.
plotRecover(A, Exp, plot.lines = TRUE, col = "blue")
plotRecover(B, Gam, new.plot = FALSE, plot.lines = TRUE, col = "red")
plotRecover(C, Wei, new.plot = FALSE, plot.lines = TRUE, col = "green")

newFit

# Función: newFit
#
# Descripción: Crear una nueva instancia de la clase "fitclass" para el ajuste de datos FRAP.
#
# Parámetros:
#   - name: Nombre del modelo de ajuste.
#   - fun: Función de ajuste.
#   - param: Nombres de los parámetros de ajuste.
#   - interval: Intervalo para cada parámetro de ajuste.
#
# Uso:
#   newFit(name, fun, param, interval)
# Ejemplo 1: Crear un nuevo modelo de ajuste usando la función Exponencial.
Exp <- newFit("Exponential", pexp, "rate", list(c(0, 1)))

# Ejemplo 2: Crear un nuevo modelo de ajuste usando la función Gamma.
Gam <- newFit("Gamma", pgamma, c("shape", "rate"), list(c(0, 5), c(0, 5)))

# Ejemplo 3: Crear un nuevo modelo de ajuste usando la función Weibull.
Wei <- newFit("Weibull", pweibull, c("shape", "scale"), list(c(0, 5), c(0, 2000)))

# Ejemplo 4: Crear un nuevo modelo de ajuste con parámetros e intervalos personalizados.
fit_custom <- newFit("Custom", myfitfunction, c("param1", "param2", "param3"),
    list(c(0, 10), c(-1, 1), c(0, 100)))

compareFit

# Función: compareFit
#
# Descripción: Comparar la bondad de ajuste entre datos y múltiples modelos.
#
# Parámetros:
#   - data: Datos a comparar (vector numérico o data frame).
#   - fit: Lista de ajustes a comparar (lista de vectores numéricos o data frames).
#   - col.lines: Paleta de colores para las líneas de ajuste (por defecto: NULL).
#   - lty.lines: Tipo de línea para las líneas de ajuste (por defecto: 1).
#   - lwd.lines: Grosor de línea para las líneas de ajuste (por defecto: 1).
#   - lwd.mean: Grosor de línea para la línea media de ajuste (por defecto: 1).
#   - digits: Número de dígitos para redondear las estadísticas de ajuste (por defecto: 4).
#   - ...: Parámetros adicionales para la función de gráfico.
#
# Uso:
#   compareFit(data, fit, col.lines = NULL, lty.lines = 1, lwd.lines = 1, lwd.mean = 1,
#              digits = 4, ...)
# Ejemplo 1: Comparar la bondad de ajuste para diferentes modelos usando datos precargados
compareFit(B, list(Exp, Wei), col.lines = c("red", "yellow"), lty.lines = c(2, 1),
           lwd.lines = 2, lwd.mean = 2)

# Ejemplo 2: Comparar la bondad de ajuste para diferentes modelos con colores y tipos de línea personalizados
compareFit(B, list(Exp, Gam, Wei), col.lines = c("blue", "green", "purple"),
           lty.lines = c(1, 3, 2), lwd.lines = 2, lwd.mean = 2)

plotFit

# Función: plotFit
#
# Descripción: Graficar el ajuste de las curvas de recuperación de fluorescencia.
#
# Parámetros:
#   - ...: Parámetros adicionales para la función de gráfico.
#   - fit: Objetos de ajuste obtenidos de la función newFit.
#   - index: Índice o índices de los objetos de ajuste a graficar.
#   - type: Tipo de curva de recuperación a graficar (por defecto: "RCB").
#   - area: Incluir normalización por área en el gráfico (por defecto: TRUE).
#   - stand: Estandarizar la curva de recuperación (por defecto: TRUE).
#   - simulated: Incluir curvas de recuperación simuladas (por defecto: FALSE).
#   - Nsim: Número de curvas simuladas a generar (por defecto: 50).
#   - seed: Valor de semilla para reproducibilidad de curvas simuladas (por defecto: NA).
#   - npoints: Número de puntos a generar en curvas simuladas (por defecto: 100).
#   - displacement: Agregar desplazamiento aleatorio a las curvas simuladas (por defecto: FALSE).
#   - new.plot: Crear un nuevo gráfico (por defecto: TRUE).
#   - plot.lines: Graficar líneas (por defecto: FALSE).
#   - plot.points: Graficar puntos (por defecto: FALSE).
#   - plot.shadow: Graficar áreas sombreadas (por defecto: FALSE).
#   - plot.mean: Graficar la curva media (por defecto: FALSE).
#   - col: Color de las curvas (por defecto: NULL).
#
# Uso:
#   plotFit(..., fit, index = NA, type = "RCB", area = TRUE, stand = TRUE, simulated = FALSE,
#           Nsim = 50, seed = NA, npoints = 100, displacement = FALSE,
#           new.plot = TRUE, plot.lines = FALSE, plot.points = FALSE, plot.shadow = FALSE,
#           plot.mean = FALSE, col = NULL)
# Ejemplo 1: Graficar el ajuste de curvas de recuperación para los objetos B y C con ajuste Exp
plotFit(B, C, fit = Exp, plot.lines = TRUE, col = c("blue", "red", "green"),
        ylim = c(0.2, 1), xdigits = 0)

# Ejemplo 2: Graficar el ajuste para el objeto B con ajuste Gam
plotFit(B, fit = Gam, plot.lines = TRUE, col = c("blue", "red", "green"),
        ylim = c(0.2, 1), xdigits = 0)

# Ejemplo 3: Graficar ajustes para los objetos B y C con múltiples ajustes y puntos
plotFit(B, C, fit = c(Exp, Gam), plot.lines = TRUE, plot.points = TRUE,
        col = c("blue", "red", "green"), ylim = c(0.2, 1), xdigits = 0)

# Ejemplo 4: Graficar ajuste para el objeto C con ajuste Wei y áreas sombreadas
plotFit(C, fit = Wei, plot.lines = TRUE, plot.shadow = TRUE,
        col = c("blue", "red", "green"), ylim = c(0.2, 1), xdigits = 0)

compareParam

# Función: compareParam
#
# Descripción: Comparar estimaciones de parámetros entre dos conjuntos de datos basándose en los resultados del ajuste.
#
# Parámetros:
#   - data1: Primer conjunto de datos de curvas de recuperación de fluorescencia.
#   - data2: Segundo conjunto de datos de curvas de recuperación de fluorescencia.
#   - fit: Objeto de ajuste que contiene los resultados del ajuste de los datos.
#   - param: Parámetro a comparar entre los conjuntos de datos.
#   - type: Tipo de curva de recuperación a considerar (por defecto: "RCB").
#   - area: Incluir normalización por área en la comparación (por defecto: TRUE).
#   - stand: Estandarizar las curvas de recuperación (por defecto: TRUE).
#   - simulated: Usar datos simulados para la comparación (por defecto: FALSE).
#   - Nsim: Número de conjuntos de datos simulados a generar (por defecto: 50).
#   - seed: Valor de semilla para simulaciones reproducibles (por defecto: NA).
#   - saveable: Permitir guardar los resultados de la simulación (por defecto: TRUE si se especifica seed).
#   - conf.level: Nivel de confianza para la comparación (por defecto: 0.95).
#   - alternative: Tipo de hipótesis alternativa para la comparación (por defecto: "two.sided").
#   - return: Devolver los resultados de la comparación (por defecto: FALSE).
#   - new.plot: Crear un nuevo gráfico (por defecto: TRUE).
#   - plot.lines: Graficar líneas en el gráfico de comparación (por defecto: TRUE).
#   - plot.points: Graficar puntos en el gráfico de comparación (por defecto: FALSE).
#   - col: Color de las curvas en el gráfico de comparación (por defecto: NULL).
#   - ...: Parámetros adicionales para el gráfico de comparación.
#
# Uso:
#   compareParam(data1, data2, fit, param, type = "RCB", area = TRUE, stand = TRUE,
#                simulated = FALSE, Nsim = 50, seed = NA, conf.level = 0.95,
#                alternative = "two.sided", return = FALSE, new.plot = TRUE,
#                plot.lines = TRUE, plot.points = FALSE, col = NULL, ...)
# Ejemplo 1: Comparar el parámetro "MF" entre los conjuntos de datos B y C usando el ajuste Wei
compareParam(B, C, fit = Wei, param = "MF", lwd.lines = 2, col.lines = "#9084c9",
             simulated = TRUE, seed = 516)

# Ejemplo 2: Comparar el parámetro "UF" entre los conjuntos de datos B y C usando el ajuste Wei
# con un nivel de confianza e hipótesis alternativa diferentes
compareParam(B, C, fit = Wei, param = "UF", lwd.lines = 2, col.lines = "#d65b22",
             simulated = TRUE, seed = 6544, conf.level = 0.99, alternative = "greater")

# Ejemplo 3: Comparar el parámetro "alpha" entre los conjuntos de datos B y B usando los ajustes Exp y Wei
# y devolviendo los resultados de la comparación
results <- compareParam(B, B, fit = c(Exp, Wei), param = "alpha", lwd.lines = 2,
                         col.lines = "#2e337e", simulated = TRUE, seed = 44648)

# Ejemplo 4: Comparar el parámetro "MF" entre los conjuntos de datos B y C usando el ajuste Gamma
# y personalizando el gráfico de comparación
compareParam(B, C, fit = Gam, param = "MF", simulated = TRUE, seed = 5959, return = TRUE)
    ## 
    ##  Welch Two Sample t-test
    ## 
    ## data:  MF_GammaSim_Secondary.Neurites and MF_GammaSim_Dendrites
    ## t = 1.773, df = 93.713, p-value = 0.07948
    ## alternative hypothesis: true difference in means is not equal to 0
    ## 95 percent confidence interval:
    ##  -0.005227574  0.092406709
    ## sample estimates:
    ## mean of x mean of y 
    ## 0.8700160 0.8264265

compareMean

# Función: compareMean
#
# Descripción: Comparar los valores medios entre dos conjuntos de datos usando ajustes FRAP.
#
# Parámetros:
#   - data1: Conjunto de datos 1 para la comparación.
#   - data2: Conjunto de datos 2 para la comparación.
#   - fit: Objeto(s) de ajuste FRAP a usar para la comparación.
#   - type: Tipo de curva de recuperación a usar para la comparación (por defecto: "RCB").
#   - area: Incluir normalización por área en la comparación (por defecto: TRUE).
#   - stand: Estandarizar las curvas de recuperación para la comparación (por defecto: TRUE).
#   - simulated: Realizar comparaciones simuladas (por defecto: FALSE).
#   - Nsim: Número de comparaciones simuladas a realizar (por defecto: 50).
#   - seed: Valor de semilla para simulaciones reproducibles (por defecto: NA).
#   - saveable: Permitir guardar los resultados de la simulación (por defecto: TRUE si se especifica seed).
#   - conf.level: Nivel de confianza para la comparación (por defecto: 0.95).
#   - alternative: Tipo de hipótesis alternativa para la comparación (por defecto: "two.sided").
#   - return: Devolver los resultados de la comparación (por defecto: FALSE).
#   - p.value: Incluir p-values en los resultados de la comparación (por defecto: TRUE).
#   - npoints: Número de puntos para graficar la curva de comparación (por defecto: 100).
#   - new.plot: Crear un nuevo gráfico (por defecto: TRUE).
#   - plot.lines: Graficar líneas para la curva de comparación (por defecto: TRUE).
#   - plot.points: Graficar puntos para la curva de comparación (por defecto: FALSE).
#   - col: Color de la curva de comparación (por defecto: NULL).
#   - ...: Parámetros adicionales para la función de gráfico.
#
# Uso:
#   compareMean(data1, data2, fit, type = "RCB", area = TRUE, stand = TRUE,
#               simulated = FALSE, Nsim = 50, seed = NA, saveable = !is.na(seed),
#               conf.level = 0.95, alternative = "two.sided", return = FALSE,
#               p.value = TRUE, npoints = 100, new.plot = TRUE, plot.lines = TRUE,
#               plot.points = FALSE, col = NULL, ...)
# Ejemplo 1: Comparar los valores medios de ajustes FRAP entre los conjuntos de datos B y C usando múltiples ajustes
compareMean(B, C, fit = c(Exp, Gam), lwd.lines = 2,
            col.lines = c("red", "green", "purple"))

# Ejemplo 2: Comparar los valores medios usando el ajuste Gam y personalizando el gráfico
compareMean(B, C, fit = Gam, lwd.lines = 2, col.lines = "orange",
             plot.lines = TRUE, plot.points = TRUE)

# Ejemplo 3: Comparar los valores medios usando el ajuste Wei
compareMean(B, C, fit = Wei, lwd.lines = 2, lty.lines = c(2, 1),
            ylim = c(0, 0.2), col.lines = c("red", "#C65153"),
            xdigits = 0, ydigits = 4)
compareMean(B, C, fit = Wei, lwd.lines = 2, col.lines = "#79189F",
            simulated = TRUE, seed = 486, new.plot = FALSE)

# Ejemplo 4: Comparar los valores medios usando el ajuste Exp
compareMean(B, C, fit = Exp, lwd.lines = 2, col.lines = "blue", return = T)[[2]]

simFit

# Función: simFit
#
# Descripción: Simular curvas de recuperación de fluorescencia basándose en un ajuste FRAP dado.
#
# Parámetros:
#   - fit: Objeto de ajuste FRAP a usar para la simulación.
#   - Nsim: Número de simulaciones a realizar (por defecto: 50).
#   - seed: Semilla para la generación de números aleatorios (por defecto: NA).
#   - saveable: Permitir guardar los resultados de la simulación (por defecto: !is.na(seed)).
#
# Uso:
#   simFit(fit, Nsim = 50, seed = NA, saveable = !is.na(seed))
# Ejemplo 1: Simular curvas de recuperación de fluorescencia basándose en el ajuste Wei con 100 simulaciones
simFit(Wei(B), Nsim = 100)

# Ejemplo 2: Simular curvas de recuperación de fluorescencia basándose en el ajuste Exp con una semilla específica
simFit(Exp(C), seed = 12345)

# Ejemplo 3: Simular curvas de recuperación de fluorescencia basándose en el ajuste Gam y guardar los resultados
simFit(Gam(B), saveable = TRUE)

tableFit

# Función: tableFit
#
# Descripción: Crear una tabla que resume los resultados de ajuste para múltiples objetos FRAP.
#
# Parámetros:
#   - ...: Múltiples objetos FRAP o una lista de objetos FRAP.
#   - fit: Objetos de ajuste FRAP a incluir en la tabla.
#   - digits: Número de dígitos para redondear los valores de la tabla (por defecto: 4).
#
# Uso:
#   tableFit(..., fit, digits = 4)
# Ejemplo 1: Crear una tabla que resume los resultados de ajuste para los objetos A, B y C usando el ajuste Wei
tableFit(A, B, C, fit = Wei)

# Ejemplo 2: Crear una tabla que resume los resultados de ajuste para los objetos B y C usando múltiples ajustes
tableFit(B, C, fit = c(Exp, Gam, Wei))

# Ejemplo 3: Crear una tabla que resume los resultados de ajuste para los objetos B, C y D con dígitos personalizados
tableFit(B, C, D, fit = Exp, digits = 2)