paisaje (version 0.2.0)

get_nightlight_data: Download and Retrieve Nightlight Data

Description

Downloads nightlight data from the Earth Observation Group's website. It scrapes the website to locate and download the latest available nightlight dataset for the specified year and month.

Usage

get_nightlight_data(
  year,
  month,
  version = "v10",
  destination_dir = NULL,
  timeout = 1200
)

Value

`character` o `NULL` Path to the downloaded `.tif` file. Returns `NULL` if no file was found or if an error occurred.

Arguments

year

`numeric` o `character` The year for which to download nightlight data (e.g., 2020).

month

`numeric` o `character` Month of the year (1–12). Will be formatted as two digits (e.g., `"03"` for March).

version

`character` Nightlight data version. Default is `"v10"`.

destination_dir

`character` Directory where the downloaded `.tif` file will be saved. Default is the current working directory `"."`.

timeout

`numeric` Timeout in seconds for the download. Default is `1200` seconds.

Details

The function constructs the appropriate URL for the specified year, month, and data version, then scrapes the directory listing to locate the latest available `.tif` file. It downloads and saves the file to the `destination_dir`. This function is useful for retrieving nightlight data for studies involving human activity, urbanization, and environmental monitoring.

Examples

# \donttest{
  # Download nightlight data for March 2021
  file_path <- get_nightlight_data(2021, 3)
  print(file_path)
# }