getMainResults.bitacora: Get main results from bitacora

Description Usage Arguments Details Value Author(s) Examples

View source: R/imarpe-main.R

Description

Principal function of bitacora class objects to get principal results.

Usage

1
2
3
4
getMainResults.bitacora(object, observedTrip = NULL, fishingHaul = NULL,
  fishingPoints = NULL, speciesComposition = NULL,
  distributionCatch = NULL, effortData = NULL, language = "spanish",
  latByPort = FALSE, specie = "anchoveta")

Arguments

object

Object of bitacora class.

observedTrip

Parameter to indicate whether the observed trip will be estimated. By default is NULL but if it will be estimated receive the logical value of TRUE.

fishingHaul

Parameter to indicate whether the fishing haul sampled will be estimated. By default is NULL but if it will be estimated receive the logical value of TRUE.

fishingPoints

Parameter to indicate whether the fishing poins will be estimated. By default is NULL but if it will be estimated received the logical value of TRUE.

speciesComposition

Parameter to indicate whether the species composition will be estimated. By default is NULL but if it will estimated received the logical value of TRUE.

distributionCatch

Parameter to indicate whether the distribution of catches will be estimated. By default is NULL but if it will estimated received the logical value of TRUE.

effortData

Parameter to indicate whether the effort data will be estimated. By default is NULL but if it will estimated received the logical value of TRUE.

language

The select language to print the results. By default is "spanish".

latByPort

logical. Parameter of fishingHaul.bitacora function. By default is FALSE indicating that latitude information is not get from port information. When is TRUE, the latitude is get from port information.

specie

character. Parameter of distributionCatch.bitacora function. Receives the name of the species that is calculated the distribution of the catch. Default value is "anchoveta" but this could be:

  • "anchoveta" to estimated the anchovy catches distribution.

  • "sardina" to estimated the sardine catches distribution.

  • "jurel" to estimated the jack mackerel catches distribution.

  • "caballa" to estimated the chub mackerel catches distribution.

  • "bonito" to estimated the bonito catches distribution.

Details

If one of the parameter (observedTrip, fishingHaul, fishingPoints, speciesComposition, distributionCatch, and effortData) is NULL on getMainResults.bitacora function the output of this parameter on the list produced by the function is NULL too.

Value

A list of bitacora_mainResults class. The length of the list is six, one by each parameter (observedTrip, fishingHaul, fishingPoints, speciesComposition, distributionCatch, and effortData).

Author(s)

Criscely Lujan-Paredes, criscelylujan@gmail.com.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
# Read a example of data base
bitacoraData = system.file("extdata", "bitacoraData.csv", package = "imarpe")

# Create a object of bitacora class
bitacoraObject = getBitacoraData(file = bitacoraData)
class(bitacoraObject)

# Get the results
mainBitacoraData = getMainResults.bitacora(object = bitacoraObject, language = "spanish",
specie = "anchoveta", observedTrip = TRUE, fishingHaul = TRUE, distributionCatch = TRUE)

# See the principal results bitacora class object
mainBitacoraData$observedTrip
mainBitacoraData$fishingHaul
mainBitacoraData$distributionCatch

imarpe/imarpe documentation built on Aug. 8, 2020, 8:40 p.m.