R/NSFigGjsnTid.R

In Rapporteket/nordicscir: R-pakke for å generere resultater fra NordicScir

#' Utvikling over tid for gjennomsnitt/median av valgt variabel
#'
#' Figuren viser gjennomsnitt/median per år med konfidensintervall for valgt variabel.
#' I bakgrunn vises konfidensintervall for det man har valt å sammenlikne med.
#'
#' Argumentet \emph{valgtVar} har følgende valgmuligheter:
#'    \itemize{
#'     \item alder: Pasientens alders
#'    }
#'
#' @inheritParams NSFigAndeler
#' @inheritParams NSVarTilrettelegg
#' @param valgtMaal
#'        'gjsn': gir middelverdi (standard)
#'        'med': gir median
#' @param valgtVar Hvilken variabel som skal visualiseres
#'
#' @return Linjediagram som viser utvikling over tid for valgt variabel
#'
#' @export
NSFigGjsnTid <- function(RegData, valgtVar='Alder', datoFra='2011-01-01', datoTil='3000-12-31',
                         datoUt = 0, tidsenhet='Aar', minald=0, maxald=110, erMann='', reshID=0,
                           enhetsUtvalg=0, valgtMaal='gjsn', AIS='', traume='alle', nivaaUt=99,
                         preprosess=1, outfile='', hentData=0, lagFigur=1,...){

  if ("session" %in% names(list(...))) {
    rapbase::repLogger(session = list(...)[["session"]], msg = paste0('FigGjsnTid: ',valgtVar))
  }
  if (hentData == 1) {
    RegData <- NSRegDataSQL(valgtVar = valgtVar)
  }

  # Hvis RegData ikke har blitt preprosessert. (I samledokument gjøre dette i samledokumentet)
  if (preprosess==1){
    RegData <- NSPreprosesser(RegData=RegData)	#, reshID=reshID)
  }


  #--------------- Definere variable ------------------------------

  NSVarSpes <- NSVarTilrettelegg(RegData=RegData, valgtVar=valgtVar, figurtype='gjsn')
  RegData <- NSVarSpes$RegData


  NSUtvalg <- NSUtvalgEnh(RegData=RegData, datoFra=datoFra, datoTil=datoTil, datoUt = datoUt,
                       minald=minald, maxald=maxald, erMann=erMann, reshID=reshID,
                       traume=traume, AIS=AIS, nivaaUt=nivaaUt, enhetsUtvalg = enhetsUtvalg)
  RegData <- NSUtvalg$RegData
  utvalgTxt <- NSUtvalg$utvalgTxt
  medSml <- NSUtvalg$medSml
  #------------------------Klargjøre tidsenhet--------------
  N <- list(Hoved = dim(RegData)[1], Rest=0)
  #N <- list(Hoved = 0, Rest =0)
  #if (N$Hoved>9) {
    RegDataFunk <- SorterOgNavngiTidsEnhet(RegData=RegData, tidsenhet = tidsenhet, datoUt=datoUt)
    RegData <- RegDataFunk$RegData
    #tidtxt <- RegDataFunk$tidtxt
    tidNum <- min(as.numeric(RegData$TidsEnhetSort), na.rm=T):max(as.numeric(RegData$TidsEnhetSort), na.rm = T) #as.numeric(levels(RegData$TidsEnhetSort))

    #--------------- Gjøre beregniNS ------------------------------
    KIekstrem <- NULL
    ind <- NSUtvalg$ind
    Ngr <- list(Hoved = length(ind$Hoved), Rest =length(ind$Rest))

    #Resultat for hovedgruppe
    N <- tapply(X = RegData[ind$Hoved ,'Variabel'], INDEX = RegData[ind$Hoved, 'TidsEnhet'], FUN = length)
    Ngr$Hoved <- tapply(X = RegData[ind$Hoved ,'Variabel'], INDEX = RegData[ind$Hoved, 'TidsEnhet'], FUN = length)
    if (valgtMaal=='med') {
      MedIQR <- plot(RegData$TidsEnhet[ind$Hoved],RegData$Variabel[ind$Hoved],  notch=TRUE, plot=FALSE)
      Midt <- as.numeric(MedIQR$stats[3, ])	#as.numeric(MedIQR$stats[3, sortInd])
      Konf <- MedIQR$conf
      #Hvis vil bruke vanlige konf.int:
      #j <- ceiling(N/2 - 1.96*sqrt(N/4))
      #k <- ceiling(N/2 + 1.96*sqrt(N/4))
      #KIHele <- sort(RegData$Variabel)[c(j,k)]
      #The notches (if requested) extend to +/-1.58 IQR/sqrt(n). (Chambers et al. (1983, p. 62), given in McGill et al. (1978, p. 16).)
      #They are based on asymptotic normality of the median and roughly equal sample sizes for the two medians being compared,
      #and are said to be rather insensitive to the underlying distributions of the samples. The idea appears to be to give
      #roughly a 95% confidence interval for the difference in two medians.
    } else {	#Gjennomsnitt blir standard.
      Midt <- tapply(RegData[ind$Hoved ,'Variabel'], RegData[ind$Hoved, 'TidsEnhet'], mean, na.rm=T)
      SD <- tapply(RegData[ind$Hoved ,'Variabel'], RegData[ind$Hoved, 'TidsEnhet'], sd, na.rm=T)
      Konf <- rbind(Midt - 2*SD/sqrt(N), Midt + 2*SD/sqrt(N))
    }

    if (length(KIekstrem) == 0) {	#Hvis ikke KIekstrem definert i variabeldefinisjonen
      KIekstrem <- c(0,max(RegData$Variabel, na.rm=T))
    }
    Konf <- replace(Konf, which(Konf < KIekstrem[1]), KIekstrem[1])
    Konf <- replace(Konf, which(Konf > KIekstrem[2]), KIekstrem[2])

    #Resten (gruppa det sammenliknes mot)
    MidtRest <- NULL
    KonfRest <- NULL
    if (medSml ==  1) {
      Nrest <- tapply(RegData[ind$Rest ,'Variabel'], RegData[ind$Rest, 'TidsEnhet'], length)
      if (valgtMaal=='med') {
        MedIQRrest <- plot(RegData$TidsEnhet[ind$Rest],RegData$Variabel[ind$Rest],  notch=TRUE, plot=FALSE)
        MidtRest <- as.numeric(MedIQRrest$stats[3, ])
        KonfRest <- MedIQRrest$conf
      } else {
        MidtRest <- tapply(RegData[ind$Rest,'Variabel'], RegData[ind$Rest, 'TidsEnhet'], mean, na.rm=T)	#ind$Rest
        SDRest <- tapply(RegData[ind$Rest,'Variabel'], RegData[ind$Rest, 'TidsEnhet'], sd, na.rm=T)
        Nrest <- tapply(RegData[ind$Rest,'Variabel'], RegData[ind$Rest, 'TidsEnhet'], length)
        KonfRest <- rbind(MidtRest - 2*SDRest/sqrt(Nrest), MidtRest + 2*SDRest/sqrt(Nrest))
      }
    }

  #}
  t1 <- switch(valgtMaal,
               med = 'Median ',
               gjsn = 'Gjennomsnittlig ')
  tittel <- paste0(t1, NSVarSpes$tittel)

  if (valgtMaal=='med') {maaltxt <- 'Median ' } else {maaltxt <- 'Gjennomsnitt '}

  ResData <- round(rbind(Midt, Konf, MidtRest, KonfRest), 1)
  rownames(ResData) <- c(maaltxt, 'KImin', 'KImaks',
                         paste0(maaltxt, 'Resten'), 'KImin, Resten', 'KImaks, Resten')[1:(3*(medSml+1))]

  FigDataParam <- list(AggVerdier=ResData,
                       N=N,
                       Ngr=Ngr,
                       grtxt=levels(RegData$TidsEnhet),
                       tittel=NSVarSpes$tittel,
                       utvalgTxt=utvalgTxt,
                       fargepalett=NSUtvalg$fargepalett,
                       medSml=medSml,
                       hovedgrTxt=NSUtvalg$hovedgrTxt,
                       smltxt=NSUtvalg$smltxt)


if (lagFigur==1) {
  #-----------Figur---------------------------------------
  if (length(ind$Hoved)<10 | ((medSml == 1) & (length(ind$Rest) < 10))) {
    rapFigurer::figtype(outfile)
    plot.new()
    title(main=tittel)
    text(0.5, 0.65, 'Færre enn 10 registreriNS i hoved-', cex=1.2)
    text(0.55, 0.6, 'eller sammenlikningsgruppe', cex=1.2)
    if ( outfile != '') {dev.off()}
  } else {

    xmin <- min(tidNum)-0.5
    xmax <- max(tidNum)+0.5
    cexgr <- 0.9	#Kan endres for enkeltvariable
    ymin <- 0.9*min(KonfRest, Konf, na.rm=TRUE)	#ymin1 - 2*h
    ymax <- 1.1*max(KonfRest, Konf, na.rm=TRUE)	#ymax1 + 2*h
    ytxt <- maaltxt #paste0(maaltxt, ytxt1, sep='')

    #Plottspesifikke parametre:
    FigTypUt <- rapFigurer::figtype(outfile, fargepalett=NSUtvalg$fargepalett)
    #Tilpasse marger for å kunne skrive utvalgsteksten
    NutvTxt <- length(utvalgTxt)
    par('fig'=c(0, 1, 0, 1-0.025*NutvTxt))

    farger <- FigTypUt$farger
    fargeHovedRes <- farger[1]
    fargeRestRes <- farger[4]
    #
    plot(tidNum,Midt, xlim= c(xmin, xmax), ylim=c(ymin, ymax), #ylim=c(ymin-0.05*ymax, ymax),
         type='n', frame.plot=FALSE, col = farger[3],
         #cex=0.8, cex.lab=0.9, cex.axis=0.9,
         ylab=c(ytxt,'med 95% konf.int.'),
         xlab=c('Innleggelsestidspunkt', 'Utskrivingstidspunkt')[datoUt+1], xaxt='n',
         sub='(Tall i boksene angir antall innleggelser)', cex.sub=cexgr)	#, axes=F)
    axis(side=1, at = tidNum, labels = levels(RegData$TidsEnhet))
    #Sammenlikning:
    if (medSml==1) {
      AntTidsenh <- max(which(!is.na(KonfRest[1,])))
      tidspkt <- c(tidNum[1]-0.01,tidNum[1:AntTidsenh], tidNum[AntTidsenh]+0.012,
                   tidNum[AntTidsenh]+0.012, tidNum[AntTidsenh:1], tidNum[1]-0.01)
      minmaks <- c(KonfRest[1,c(1,1:AntTidsenh, AntTidsenh)], KonfRest[2,c(AntTidsenh,AntTidsenh:1,1)])
      ind <- which(is.na(minmaks))
      dummy <- c(0.9*MidtRest[c(1,1:AntTidsenh, AntTidsenh)], 1.1*MidtRest[c(AntTidsenh,AntTidsenh:1,1)])
      minmaks[ind] <- dummy[ind]
      if (sum(is.na(minmaks))==0) {
      polygon(x = tidspkt, y = minmaks, col=fargeRestRes, border=NA)

      legend('top', bty='n', fill=fargeRestRes, border=fargeRestRes, cex=cexgr,
             paste0('95% konfidensintervall for ', NSUtvalg$smltxt, ', N=', sum(Nrest, na.rm=T)))
      }
    }
    h <- strheight(1, cex=cexgr)*0.7	#,  units='figure',
    b <- 1.1*strwidth(max(N, na.rm=T), cex=cexgr)/2	#length(tidNum)/30
    rect(tidNum-b, Midt-h, tidNum+b, Midt+h, border = fargeHovedRes, lwd=1)	#border=farger[4], col=farger[4]
    text(tidNum, Midt, N, col=fargeHovedRes, cex=cexgr)

    #Konfidensintervall:
    ind <- which(Konf[1, ] > Midt-h) #Konfidensintervall som er tilnærmet 0
    options('warn'=-1)
    arrows(x0=tidNum, y0=Midt-h, x1=tidNum, length=0.08, code=2, angle=90,
           y1=replace(Konf[1, ], ind, Midt[ind]-h), col=fargeHovedRes, lwd=1.5)
    arrows(x0=tidNum, y0=Midt+h, x1=tidNum, y1=replace(Konf[2, ], ind, Midt[ind]+h),
           length=0.08, code=2, angle=90, col=fargeHovedRes, lwd=1.5)

    title(main=c(tittel, NSUtvalg$hovedgrTxt), font.main=1, line=1)
    #Tekst som angir hvilket utvalg som er gjort
    if (length(utvalgTxt)>0) {
      mtext(utvalgTxt, side=3, las=1, cex=0.9, adj=0, col=farger[1], line=c(3+0.8*((NutvTxt-1):0)))}

    if ( outfile != '') {dev.off()}

  }	#end if statement for 0 observations
} #lag figur
  return(invisible(FigDataParam))

}	#end function