Skip to contents

Extract Data for a Specified Fishing Area and Optionally Generate Plots

Source: R/fishing_area_data.R
fishing_area_data.Rd

This function extracts and returns data for a specified FAO major fishing area. If the plot parameter is TRUE, it will also generate and save plots to the figures directory. The percentage chart shows the share of the area in the world catch of all marine areas (or, for an inland area, of all inland waters).

Usage

fishing_area_data(
  area_name,
  plot = TRUE,
  timeseries_analysis = TRUE,
  area_color1 = "grey80",
  area_alpha = 0.7,
  area_color2 = "black",
  line_color = "black",
  line_alpha = 0.8,
  point_size = 2,
  hline_color = "red",
  hline_alpha = 0.7,
  hline_linewidth = 1.5,
  line_linewidth = 1.5,
  axis_text_face = "plain",
  axis_title_face = "bold",
  strip_text_face = "bold",
  axis_text_size = 10,
  axis_title_size = 12,
  strip_text_size = 12,
  polygon_color = "grey90",
  fill_scale = NULL,
  axis_title_size_map = 14,
  axis_text_size_map = 12,
  legend_text_size_map = 12,
  ZH = FALSE,
  lang = NULL,
  data_version = "latest",
  pptx = getOption("faofishingreport.pptx", FALSE),
  plot_show = fao_setting("plot_show")
)

Arguments

area_name

The name of the FAO major fishing area.

plot

A logical indicating whether to generate and save plots. Default is TRUE.

timeseries_analysis

A logical value. If TRUE (default), the total catch chart shows the periods between breakpoints in the mean catch (Bai-Perron test, strucchange::breakpoints()).

area_color1

The fill colour of the total catch chart. Default is "grey80".

area_alpha

The alpha transparency for the area plot. Default is 0.7.

area_color2

The outline colour of the total catch chart. Default is "black".

line_color

The color to use for line plots. Default is "black".

line_alpha

The alpha transparency for line plots. Default is 0.8.

point_size

The size of points in the percentage plot. Default is 2.

hline_color

The color of the horizontal line in the percentage plot. Default is "red".

hline_alpha

The alpha transparency of the horizontal line in the percentage plot. Default is 0.7.

hline_linewidth

Line width for the horizontal line. Default is 1.5.

line_linewidth

Line width for the line geom. Default is 1.5.

axis_text_face

The font face of the axis text of the total catch chart. Default is "plain".

axis_title_face

The font face of the axis titles of the charts and the map. Default is "bold".

strip_text_face

Not used (the charts have no panels). Default is "bold".

axis_text_size

The size of the axis text of the percentage chart. Default is 10.

axis_title_size

The size of the axis titles of the total catch and percentage charts. Default is 12.

strip_text_size

Not used (the charts have no panels). Default is 12.

polygon_color

The color of the borders of the polygons in the map plot. Default is "grey90".

fill_scale

The colour palette of the map. Default is NULL, which uses map_palette of fao_settings() ("deep-orange" unless changed); see ?fao_settings for the choices.

axis_title_size_map

The size of the axis title text in the map plot. Default is 14.

axis_text_size_map

The size of the axis text in the map plot. Default is 12.

legend_text_size_map

The size of the legend text in the map plot. Default is 12.

ZH

A logical value. If TRUE, chart text and names are in Chinese. Default is FALSE. ZH = TRUE is the same as lang = "zh".

lang

The language of the chart text: "en" (English), "zh" (Chinese) or "both" (Chinese and English). Default is NULL, which uses "zh" if ZH = TRUE, and otherwise the language set with fao_settings() ("en" unless changed).

data_version

The FAO data release to use: "latest" (default) uses the newest of the releases downloaded with download_fao_data() and the data bundled with the package; "bundled" uses the data bundled with the package; or a release such as "2026.1.0".

pptx

A logical value. Charts are always saved as PNG in figures/png/; if TRUE they are also saved as editable PowerPoint files in figures/pptx/. Default is FALSE, which can be changed for all functions with fao_settings(pptx = TRUE).

plot_show

A logical value. If TRUE, each chart is also drawn in the plot window (e.g. the Plots pane of RStudio) as it is saved, to look at it at once. Default is FALSE, which can be changed for all functions with fao_settings(plot_show = TRUE). The charts are saved as files (plot = TRUE) either way.

Value

A list with area_data (the FAO data of the area), coefs_data (start year, end year and mean catch of each period between breakpoints) and act_world_map (the map data).

See also

Other fishing area analyses: fishing_area_country(), fishing_area_species()

Examples

if (FALSE) { # \dontrun{
# Firstly, data preparing and loading.
FAO27 <- fishing_area_data("Atlantic, Northeast")
} # }