Skip to content

README.md

Latest commit

 

History

History
64 lines (43 loc) · 2.27 KB

README.md

File metadata and controls

64 lines (43 loc) · 2.27 KB

ENSO classification package

codecov example branch parameter licencia languages commits R-version

Classify dates by season and El Niño-Southern Oscillation (ENSO) phase.

How it works

Provide a list of dates and a NOAA ONI dataset. The package returns each date with its season and ENSO phase (El Niño, La Niña, or Neutral).

Feature Status
Classify dates by season (Winter, Spring, Summer, Fall) Ready
Classify dates by ENSO phase (Niño, Niña, Neutral) Ready
CLI option definitions for automation scripts Ready

Before you start

You need an ONI dataset from NOAA in wide format with a Year column and trimester columns (DJF, JFM, FMA, MAM, AMJ, MJJ, JJA, JAS, ASO, SON, OND, NDJ).

Run the project

With Docker (recommended)

docker compose build
docker compose run islasgeci R

Inside the container, load the package:

library(enso)

Without Docker

Install the package and its dependencies:

remotes::install_github("IslasGECI/testtools")
remotes::install_github("IslasGECI/enso")

Core concept

If you pass a data frame with a Date column and ONI data to classify_by_season_and_enso_phase(), you get back the same data frame with two new columns:

  • Season — Winter, Spring, Summer, or Fall, determined from the date.
  • ENSO_Phase — Niño, Niña, or Neutral, determined from the ONI values.

The ENSO phase is classified using a five-consecutive-month threshold: five or more months with ONI ≥ 0.5 indicates El Niño; five or more months with ONI ≤ -0.5 indicates La Niña.

Coming soon

  • Integration with gecioptparse for command-line argument parsing.
  • Additional ONI data sources and formats.
  • Batch processing of multiple date lists.