55 lines
2.4 KiB
R
55 lines
2.4 KiB
R
# ============================================================================
|
|
# SCRIPT XX: [DESCRIPTIVE TITLE]
|
|
# ============================================================================
|
|
# PURPOSE:
|
|
# [What this script does in 2-3 sentences. Example: Downloads satellite
|
|
# imagery from Planet API, processes 4-band RGB+NIR data, and saves
|
|
# merged GeoTIFFs for use by downstream analysis stages.]
|
|
#
|
|
# INPUT DATA:
|
|
# - Source: [Which directory/files it reads. Example: Planet API, hardcoded bbox]
|
|
# - Format: [TIFF, RDS, GeoJSON, etc. Example: 4-band uint16 GeoTIFF]
|
|
# - Location: [Full path example]
|
|
#
|
|
# OUTPUT DATA:
|
|
# - Destination: [Which directory/files it creates. Example: laravel_app/storage/app/{project}/merged_tif/]
|
|
# - Format: [TIFF, RDS, CSV, etc. Example: Single-band float32 GeoTIFF]
|
|
# - Naming convention: [Example: {YYYY-MM-DD}.tif]
|
|
#
|
|
# USAGE:
|
|
# Rscript XX_script_name.R [arg1] [arg2] [arg3]
|
|
#
|
|
# Example (Windows PowerShell):
|
|
# & "C:\Program Files\R\R-4.4.3\bin\x64\Rscript.exe" r_app/XX_script_name.R angata 2026-01-15
|
|
#
|
|
# PARAMETERS:
|
|
# - arg1: [Description, type, and valid values. Example: project (character) - angata, chemba, xinavane, esa, simba]
|
|
# - arg2: [Description, type, and valid values. Example: date (character, optional) - ISO format YYYY-MM-DD; default today]
|
|
#
|
|
# CLIENT TYPES:
|
|
# - cane_supply (ANGATA): [Yes/No - if Yes, briefly explain any differences]
|
|
# - agronomic_support (AURA): [Yes/No - if Yes, briefly explain any differences]
|
|
#
|
|
# DEPENDENCIES:
|
|
# - Packages: [dplyr, tidyr, terra, sf, readr, writexl, etc.]
|
|
# - Utils files: [parameters_project.R, 00_common_utils.R, XX_utils.R, etc.]
|
|
# - External data: [harvest.xlsx, pivot.geojson, etc.]
|
|
# - Data directories: [laravel_app/storage/app/{project}/]
|
|
#
|
|
# NOTES:
|
|
# [Any special considerations, assumptions, or future improvements.
|
|
# Example: Cloud filtering uses CI >= 0.5 threshold. Multi-field support
|
|
# implemented via field geometry masking from pivot.geojson.]
|
|
#
|
|
# RELATED ISSUES:
|
|
# SC-XXX: [Brief description of related work]
|
|
#
|
|
# HISTORY:
|
|
# 2026-02-03: [Description of change, if refactored or enhanced]
|
|
# ============================================================================
|
|
|
|
# NOTE: This is a TEMPLATE file for documentation purposes only.
|
|
# When creating a new script or updating an existing one, copy this template
|
|
# and fill in all sections with accurate information about your specific script.
|
|
# Then delete this comment block.
|