R/createOccProb.R

In NINAnor/SurveyPower: Functions for calculating power of survey design

#' createOccProb
#'
#' Creates a probability of species occurrence based on explanatory factors.
#' The levels are calculated additively with a fylke effect, a kommune effect, plus a random part (sigma) that
#' determines the intra-kommune variation among grid cells.
#' This is intended to fill a "map" with values of occurrences, and expects columns named fylke and kommune.
#'
#' @param formula Not yet implemented
#' @param sigmaFylke Standard deviance of fylkes
#' @param sigmaFylke Standard deviance of kommunes.
#' @param sigmaFylke Standard deviance of grids.
#'
#' @export
#'
#' @examples
#' \dontrun{
#'
#' }
#' @import sf
#' @import tidyverse


createOccProb <- function(map,
                          intercept = 0.5,
                          formula = ~ NULL,
                          sigmaFylke = 0.1,
                          sigmaKommune = 0.1,
                          sigmaGrid = 0,
                          sigmaFylkeTrend = 0,
                          sigmaKommuneTrend = 0,
                          artypeEff = c("Bebygd" = 0,
                                        "Samferdsel" = 0,
                                        "Fulldyrka jord" = 0,
                                        "Overflatedyrka jord" = 0,
                                        "Innmarksbeite" = 0,
                                        "Skog" = 0,
                                        "Åpen fastmark" = 0,
                                        "Myr" = 0,
                                        "Isbre" = 0,
                                        "Ferskvann" = 0,
                                        "Hav" = 0,
                                        "Ikke kartlagt" = 0
                          ),
                          artypeTrend = c("Bebygd" = 0,
                                          "Samferdsel" = 0,
                                          "Fulldyrka jord" = 0,
                                          "Overflatedyrka jord" = 0,
                                          "Innmarksbeite" = 0,
                                          "Skog" = 0,
                                          "Åpen fastmark" = 0,
                                          "Myr" = 0,
                                          "Isbre" = 0,
                                          "Ferskvann" = 0,
                                          "Hav" = 0,
                                          "Ikke kartlagt" = 0
                          ),
                          nYears = 5,
                          interceptTrend = -0.05,
                          sdInterceptTrend = 0,
                          sortFylke = T,
                          sortKommune = T,
                          sortGrid = T) {

  #range01 <- function(x){(x-min(x))/(max(x)-min(x))}
  #formula <- as.formula(formula)
  # formulaEff <- map %>%
  #   select(all.vars(formula)) %>%
  #   as.matrix() %>%
  #   range01() %*% fylkeParams


  #fylkeEff
  .fylkeEff <- dplyr::tibble(FYLKESNUMMER = unique(map$FYLKESNUMMER))
  .fylkeVals <- rnorm(nrow(.fylkeEff), 0, sigmaFylke)
  .fylkeTrends <- rnorm(nrow(.fylkeEff), 0, sigmaFylkeTrend)
  if(sortFylke){
    .fylkeVals <- sort(.fylkeVals)
    .fylkeTrends <- sort(.fylkeTrends)
  }
  .fylkeEff <- .fylkeEff %>%
    transform(fylkeEff = .fylkeVals,
              fylkeTrend = .fylkeTrends)
  map <- map %>%
    left_join(.fylkeEff, by = c("FYLKESNUMMER" = "FYLKESNUMMER"))

  ##kommuneEff
  .kommuneEff <- dplyr::tibble(KOMMUNENUMMER = unique(map$KOMMUNENUMMER))
  .kommuneVals <- rnorm(nrow(.kommuneEff), 0, sigmaKommune)
  .kommuneTrends <- rnorm(nrow(.kommuneEff), 0, sigmaKommuneTrend)
  if(sortKommune){
    .kommuneVals <- sort(.kommuneVals)
    .kommuneTrends <- sort(.kommuneTrends)
  }
  .kommuneEff <- .kommuneEff %>%
    transform(kommuneEff = .kommuneVals,
              kommuneTrend = .kommuneTrends)
  map <- map %>%
    dplyr::left_join(.kommuneEff, by = c("KOMMUNENUMMER" = "KOMMUNENUMMER"))

  #gridEff
  .gridVals <- rnorm(nrow(map), 0, sigmaGrid)
  if(sortGrid){
    .gridVals <- sort(.gridVals)
  }
  map <- map %>%
    transform(gridEff = .gridVals)


  ##artypeEff
  #use left_join to attach the artype values to the map
  artypeEff <- tibble(ARTYPE = names(artypeEff),
                         artypeEff = artypeEff)

  artypeTrend <- tibble(ARTYPE = names(artypeTrend),
                      artypeTrend = artypeTrend)

  map <- map %>%
    left_join(artypeEff, by = c("ARTYPE" = "ARTYPE"))

  map <- map %>%
    left_join(artypeTrend, by = c("ARTYPE" = "ARTYPE"))

  #sum the effects, using invlogit link
  out <- map %>%
    transform(year = 1,
              prob = exp(artypeEff + intercept + fylkeEff + kommuneEff + gridEff)/(1+exp(artypeEff + intercept + fylkeEff + kommuneEff + gridEff)))

  if(nYears > 1){
    increment <- list()
    for(i in 2:nYears){
      increment[[(i-1)]] <- map %>%
        transform(year = i,
                   prob = exp(artypeEff + artypeTrend * i + intercept + rnorm(nrow(map), interceptTrend, sdInterceptTrend) * i + fylkeEff + fylkeTrend * i + kommuneEff + kommuneTrend * i + gridEff)/
                     (1 + exp(artypeEff + artypeTrend * i + intercept + rnorm(nrow(map), interceptTrend, sdInterceptTrend) * i + fylkeEff + fylkeTrend * i + kommuneEff + kommuneTrend * i + gridEff)))

         }

    increments <- do.call(rbind, increment)

  combined <- rbind(out, increments) %>%
    dplyr::as_tibble()  %>%
    sf::st_as_sf()


  }

  combined <- combined %>%
    mutate(KOMMUNENUMMER = as.integer(KOMMUNENUMMER))

  return(combined)
}