R/plot_relationship_duration.R

In EvoNetHIV/Test_and_Treat: Evonet: Integrated Bio-Social Models for HIV Epidemiology

#' @title Title
#'
#' @description Description
#'
#' @param x A number.
#' @param y A number.
#' @return return value here.
#' @details
#' Additional details here
#' @examples
#' example function call here

#' @export
plot_relationship_duration <- function(model){
  #note: parameter "save_network=T" to run fxn
 #plots only first simulation, ignores censored (begin,end) data
  
if(!isTRUE(model$param[[1]]$save_network)){return(invisible(NULL))}
if(isTRUE(model$param[[1]]$fast_edgelist)){return(invisible(NULL))}
  
dframe <- networkDynamic::get.edge.activity(model$nw[[1]], 
                                           as.spellList = TRUE, 
                                           active.default = F)

ix <- dframe$duration<1e6
if (max(ix) > 0) {  # Don't make histogram if all elements are false
   durations <- dframe$duration[ix]
   hist(durations,breaks=100,col="blue",xlab="duration",
       main="relationship duration distribution")
  }
}