R/ConductMultipleSurveys.R

ConductMultipleSurveys <- structure(
function # Conduct multiple simulations of a bus-route survey

  ###############################################################################
  # File:  ConductMultipleSurveys.R
  ## author<< Steven H. Ranney
  ## Contact: \email{[email protected]}
  # Created: 3/25/14/13  
  # Last Edited: 4/9/14 by SHR
  ##description<<This function uses \code{MakeAnglers} and \code{GetTotalValues} 
  ## to  conduct multiple bus-route or traditional access point creel surveys (from
  ## the number provided to the \code{nsims} argument) of a population of anglers.
  # Returns: Estimate catch (Ehat), the catch rate calculated by the ratio of means, 
  # the true, observed catch, and the actual catch rate (meanLambda).
  #
  # TODO: add testing section
  ###############################################################################

  (nsims,  ##<<The number of simulations to be conducted in the simulation of interest.
  ... ##<<Arguments to be passed to other subfunctions
  ){ 
    
  ##details<<Because this function is merely a wrapper for the \code{\link{SimulateBusRoute}}
  ## code, the user still needs to set \code{startTime}, \code{waitTime}, 
  ## \code{nanglers}, \code{nsites}, and \code{samplingProb} as objects.  These 
  ## can be passed through the \code{...} argument or through setting \code{waitTime}
  ## and others outside of the function call itself.
  
  busRoute <- as.data.frame(matrix(data = NA, ncol = 5, nrow = nsims, byrow=T))
  names(busRoute) <- c("Ehat", "catchRateROM", "trueCatch", "trueEffort", "meanLambda")
  
  ##seealso<<\code{\link{MakeAnglers}}
  ##seealso<<\code{\link{GetTotalValues}}
  ##seealso<<\code{\link{SimulateBusRoute}}
  
  for(i in 1:nrow(busRoute)){
    busRoute[i,] <- SimulateBusRoute(...)
  }
    
  #busRoute <<- busRoute
  return(busRoute)
  
  }, ex = function() {
  
  #These objects are not used directly in the ConductMultipleSurveys() function
  # but will be used in the SimulateBusRoute() function
  startTime <- c(1, 2,3,4,5) 
  waitTime <- c(.5, .5, .5, .5, 2) 
  nanglers <- c(10,10,10,10,50) 
  nsites <- 5
  samplingProb <- .5
  meanCatchRate <- 3
  
  nsims <- 100
  
  tmp <- ConductMultipleSurveys(100, startTime = startTime, waitTime = waitTime, 
                              nanglers = nanglers, nsite = nsites, 
                              samplingProb = samplingProb, meanCatchRate = meanCatchRate)
 
  
  #To change fishingDayLength used in the MakeAnglers function
  ConductMultipleSurveys(nsims, startTime, waitTime, nanglers, nsites, samplingProb, 
                         meanCatchRate, fishingDayLength = 9.5)
  })
stevenranney/creelSurvey documentation built on Dec. 21, 2017, 2:23 p.m.