R/plotly_duane.R

In WeibullR.plotly: Interactive Weibull Probability Plots

#' Interactive Duane Plot.
#'
#' @param duane_obj An object of class 'duane'.
#' @param showGrid Show grid (TRUE) or hide grid (FALSE).
#' @param main Main title.
#' @param xlab X-axis label.
#' @param ylab Y-axis label.
#' @param pointCol Color of the point values.
#' @param fitCol Color of the model fit.
#' @param gridCol Color of the grid.
#' @return The function returns no value.
#' @examples
#' library(ReliaGrowR)
#' times<-c(100, 200, 300, 400, 500)
#' failures<-c(1, 2, 1, 3, 2)
#' fit<-duane_plot(times, failures)
#' plotly_duane(fit)
#' @import ReliaGrowR plotly
#' @importFrom graphics text
#' @importFrom stats runif qnorm
#' @export

plotly_duane <- function(duane_obj,
                       showGrid = TRUE,
                       main = "Duane Plot",
                       xlab = "Cumulative Time",
                       ylab = "Cumulative MTBF",
                       pointCol = "black",
                       fitCol = "black",
                       gridCol = "lightgray") {

  # Validate inputs
  validate_inputs <- function() {
    if (!identical(class(duane_obj), "duane")) {
      stop("Argument 'duane_obj' is not of class 'duane'.")
    }
  }
  validate_inputs()

  # Create the  plot
  plotDuane <- function() {

    # Set up the plot layout
    xgrid <- ifelse(is.null(showGrid) || isTRUE(showGrid), TRUE, FALSE)
    ygrid <- xgrid

    # Extract data from duane_obj
    times <- duane_obj$Cumulative_Time
    mtbf <- duane_obj$Cumulative_MTBF
    fitted <- duane_obj$Fitted_Values

    duanePlot <- plot_ly(x=times, y=mtbf, type='scatter', mode='markers',
                         marker=list(color=pointCol), showlegend=FALSE, name="",
                         text=~paste0("MTBF: (",times,", ",mtbf,")"), hoverinfo = 'text'
    ) %>%

      # Set up the main probability plot layout
      layout(title=main,
             xaxis = list(type='log', title=xlab, showline=TRUE, mirror='ticks',
                          showgrid=TRUE, gridcolor=gridCol),
             yaxis = list(type='log', title=ylab, showline=TRUE, mirror = 'ticks',
                          size=text, showgrid=TRUE, gridcolor=gridCol)
      ) %>%

      # Add best fit
      add_trace(x=times, y=fitted, mode='markers+lines',
                marker=list(color='transparent'), line = list(color = fitCol),
                text=~paste0("Fit: ",times,", ",fitted,")"), hoverinfo = 'text'
      )

    return(duanePlot)
  }
  final_plot <- plotDuane()

  return(final_plot)
}