---
title: "Parameters Overview" 
output: 
  rmarkdown::html_vignette:
    css: styles/vignette.css
vignette: >
  %\VignetteIndexEntry{Parameters Overview}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

## Introduction

This vignette serves as a comprehensive guide to the parameters used in the OptirrigCORE project. 
It provides detailed explanations and references for each parameter, helping users understand their purpose and how to configure them effectively.
Whether you are a new user or an experienced developer, this document will assist you in making the most of the parameter settings.

```{r, 00-load_ParamFile, include=FALSE}
library(OptirrigCORE)
library(dplyr)
library(kableExtra)
params <- read(system.file("extdata", "params.desc.csv", package = "OptirrigCORE"))
```

## Run
```{r, 00-Run-parameters, echo=FALSE}
params %>%
  filter(category == "run") %>%
  select(Parameters = label, Description = desc, Type = types) %>%
  kable("html", table.attr = "style='font-size: 80%; width: 100%;'") %>%
  kable_styling(full_width = TRUE, position = "center", bootstrap_options = c("striped", "hover", "condensed")) %>%
  column_spec(1, width = "20%") %>%
  column_spec(2, width = "60%") %>%
  column_spec(3, width = "20%")
```

## Crop
```{r, 00-climate-parameters, echo=FALSE}
params %>%
  filter(category == "crop") %>%
  select(Parameters = label, Description = desc, Type = types) %>%
  kable("html", table.attr = "style='font-size: 80%; width: 100%;'") %>%
  kable_styling(full_width = TRUE, position = "center", bootstrap_options = c("striped", "hover", "condensed")) %>%
  column_spec(1, width = "20%") %>%
  column_spec(2, width = "60%") %>%
  column_spec(3, width = "20%")
```

## Soil
```{r, 00-soil-parameters, echo=FALSE}
params %>%
  filter(category == "soil") %>%
  select(Parameters = label, Description = desc, Type = types) %>%
  kable("html", table.attr = "style='font-size: 80%; width: 100%;'") %>%
  kable_styling(full_width = TRUE, position = "center", bootstrap_options = c("striped", "hover", "condensed")) %>%
  column_spec(1, width = "20%") %>%
  column_spec(2, width = "60%") %>%
  column_spec(3, width = "20%")
```

## Yield
```{r, 00-yield-parameters, echo=FALSE}
params %>%
  filter(category == "yield") %>%
  select(Parameters = label, Description = desc, Type = types) %>%
  kable("html", table.attr = "style='font-size: 80%; width: 100%;'") %>%
  kable_styling(full_width = TRUE, position = "center", bootstrap_options = c("striped", "hover", "condensed")) %>%
  column_spec(1, width = "20%") %>%
  column_spec(2, width = "60%") %>%
  column_spec(3, width = "20%")
```

## Economics
```{r, 00-eco-parameters, echo=FALSE}
params %>%
  filter(category == "economics") %>%
  select(Parameters = label, Description = desc, Type = types) %>%
  kable("html", table.attr = "style='font-size: 80%; width: 100%;'") %>%
  kable_styling(full_width = TRUE, position = "center", bootstrap_options = c("striped", "hover", "condensed")) %>%
  column_spec(1, width = "20%") %>%
  column_spec(2, width = "60%") %>%
  column_spec(3, width = "20%")
```

## Irrigation (option)
```{r, 00-irrigation-parameters, echo=FALSE}
params %>%
  filter(category == "irrigation") %>%
  select(Parameters = label, Description = desc, Type = types) %>%
  kable("html", table.attr = "style='font-size: 80%; width: 100%;'") %>%
  kable_styling(full_width = TRUE, position = "center", bootstrap_options = c("striped", "hover", "condensed")) %>%
  column_spec(1, width = "20%") %>%
  column_spec(2, width = "60%") %>%
  column_spec(3, width = "20%")
```