SITUAS Reports Metadata (Internal)

Internal dataset containing metadata about all available SITUAS API reports. This data is used internally by package functions to validate report IDs, provide helpful error messages, and determine report types.

Format

A data.table with the following columns:

pfun

Integer. Report ID (function number) used in API calls

title

Character. Full title of the report in Italian

date_range

Character. Validity period of the report (format: DD/MM/YYYY - DD/MM/YYYY)

analysis_type

Character. Type of temporal analysis:

  • DATA: Single date parameter

  • PERIODO: Date range parameters (start and end)

  • ATTUALIZZAZIONE: Actualization/translation (uses date range like PERIODO)

info

Character. Additional information about the report (may be NA)

Details

This dataset is stored in R/sysdata.rda and is not exported to package users. It is automatically loaded when the package is loaded and is available to all internal package functions.

The data originates from the situas_api.xlsx file and is processed by the data-raw/prepare_reports_data.R script. To update this data when new reports are added to the SITUAS API, update the Excel file and re-run the preparation script.

API Mapping

For API calls:

  • DATA reports: Use single pdata parameter

  • PERIODO reports: Use pdatada (start) and pdataa (end)

  • ATTUALIZZAZIONE reports: Treated as PERIODO (use date range)