/
Environment configuration (ff_environment)

Environment configuration (ff_environment)

After installing the ForestForesight package, the first thing we recommend doing is to configure your environment. The package provides an interactive setup function called ff_environment() that will guide you through this process.

Simply run:

library(ForestForesight) ff_environment()

This will launch an interactive prompt that walks you through setting up important parameters like:

  • Your earliest data processing date

  • Default ground truth pattern (1, 3, 6, or 12 months)

  • Forest mask settings

  • Local data storage location

  • Logging preferences

The configuration will be saved to:

  • Windows: %APPDATA%/forestforesight/config.yml

  • Unix/Mac: ~/.forestforesight/config.yml

If you need to change any settings later, you can either:

  • Run ff_environment() again and reconfigure everything

  • Directly edit the config.yml file in your configuration directory

That's it! Once you've completed the configuration, you're ready to start using ForestForesight's other functions.

Related content