HI_record: Generate One or several Header Information (HI) records

View source: R/format_records.R

HI_recordR Documentation

Generate One or several Header Information (HI) records

Description

HI_record returns comma separated text line(s) to be used in a files imported into ICES InterCatch database. See http://datsu.ices.dk/web/selRep.aspx?Dataset=76. To reduce the risk of enter data in the wrong place we recommend that you always use named parameter list when calling this function

Usage

HI_record(
  Country,
  Year,
  SeasonType,
  Season,
  Fleet,
  AreaType,
  FishingArea,
  DepthRange = NA,
  UnitEffort,
  Effort,
  AreaQualifier = NA
)

Arguments

Country

character vector (mandatory)

Year

numeric vector (mandatory)

SeasonType

character vector. Keywords defined by ICES see doc (mandatory)

Season

numeric vector (mandatory)

Fleet

character vector. Keywords defined by ICES see doc (mandatory)

AreaType

character vector. Keywords defined by ICES see doc (mandatory)

FishingArea

character vector. Keywords defined by ICES see doc (mandatory)

DepthRange

currently not used. Set to NA by default (optional)

UnitEffort

character vector. Keywords defined by ICES see doc (optional)

Effort

numeric vector (optional)

AreaQualifier

currently not used. Set to NA by default (optional)

Value

A comma separated text string in InterCatch HI format

Examples

 HI_record(Country = "SE", Year = 2019, SeasonType = "Month", Season = 6, Fleet = "FYK_C",
 AreaType = "SubDiv", FishingArea = "27.d.3.31", UnitEffort = "gd", Effort = NA)


kagervall/ICimportr documentation built on March 18, 2024, 5:19 a.m.