Skip to contents

Analyze and Plot the Global Catch of a Country

Source: R/country_analysis.R
country_analysis.Rd

This function takes a country name, analyzes the catch of that country in all FAO fishing areas, and identifies the top species and fishing areas by production at the ranks chosen with rank_range.

Usage

country_analysis(
  country_name,
  rank_range = 1:10,
  plot = TRUE,
  table = TRUE,
  timeseries_analysis = TRUE,
  time_analysis_text_displacement = 10,
  h_value = 0.15,
  ZH = FALSE,
  fill_scale = NULL,
  lang = NULL,
  data_version = "latest",
  pptx = getOption("faofishingreport.pptx", FALSE),
  plot_show = fao_setting("plot_show")
)

Arguments

country_name

A string specifying the country to be analyzed.

rank_range

The ranks of the species to show, ranked by the catch of the country: the ranks listed, e.g. 1:10 (default) for the first ten, c(5, 6) for the fifth and sixth, or c(1, 10) for the first and the tenth. Ranks beyond the number of species are left out. Until version 0.9.0 two numbers gave the first and the last rank (c(1, 10) was the first ten).

plot

A logical value indicating whether to generate and save plots.

table

A logical value indicating whether to generate and save tables

timeseries_analysis

A logical value indicating whether to analysis timeseries.

time_analysis_text_displacement

The number of years after the first year of data at which the percentage labels are placed in the faceted time series plot. Default is 10.

h_value

The minimum segment size passed to strucchange::breakpoints(): a fraction of the series length (default 0.15) or a number of years.

ZH

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

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.

lang

The language of the chart text and names: "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 country_species_ranked (yearly catch of the ranked species), country_species_ranked_coefs_data (periods between breakpoints of each species), table (catch by species and FAO area), country_species_area_total (total catch of each species in each area) and country_yearly_area_production (yearly catch in each area). Charts and tables are saved if plot and table are TRUE.

See also

Other species and country analyses: country_species(), species_country()

Examples

if (FALSE) { # \dontrun{
country_analysis("Norway", rank_range = 1:10)   # the ten main species of Norway
} # }