R/eq12_Pcpp.R

In brouwern/FACavian: An R implementation and extension of full-annual cycle (FAC) model of Runge & Marra *2005)

#' Equation 12: Proportion of pairs between a male and female both from poor habitat (P.cpp)
#'
#'  The proportion of pairings between a male and female both originating from poor winter habitat  is calculated by subtraction using values calcualted by previous equations.
#'
#' Note that in the original paper, equations 10 and 11 both are named "P.cgp" but in equation 12 it is implied that 10 should be P.cgp while 11 should P.cpg.  This would maake the 2nd subscript for the male condition (P.cg_) and the 3rd subscript for the female condition (P.c_p)
#'
#'
#' @param P.cgg Proportion of pairs in source (c) where male and female both originated from good (gg) winter habitat
#' @param P.cgp Proportion of pairs in source (c) where male originated from good (g) and female originated from poor winter habitat
#' @param P.cpg Proportion of pairs in source (c) where male originated from poor (p) and female originated from good (g) winter habitat
#' @param ... Additional parameters
#'
#' @return P.cpp: Scalar - Proportion of pairs between a male and female both from poor habitat
#'
#' @examples
#' eq12_Pcpp(P.cgg = 1, P.cgp = 0.0, P.cpg = 0.0)
#'
#' @export

eq12_Pcpp <- function(P.cgg,
                 P.cgp,
                 P.cpg,
                 ...){
  P.cpp <-  round(1 - P.cgg - P.cgp - P.cpg, 5)

  if(P.cpp > 1| P.cpp < 0){
    warning("Equation produces invalied value")
  }

  return(P.cpp)
  }