Skip to content

Commit

Permalink
improve text
Browse files Browse the repository at this point in the history
  • Loading branch information
EhrmannS committed Dec 19, 2024
1 parent c0cda76 commit 0537022
Show file tree
Hide file tree
Showing 18 changed files with 3,351 additions and 8 deletions.
2 changes: 1 addition & 1 deletion vignettes/getting_started.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ for(grd in seq_along(.grid)){
}
# or more classically (even though this could be further streamlined )
# or more classically (even though this could be further streamlined just as above)
minimal <- minimal |>
clue_landtype(name = "forest", resistance = 0.5,
suitability = .suit |> filter(type == "forest") |> select(-type),
Expand Down
27 changes: 20 additions & 7 deletions vignettes/use_cases.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,20 @@ knitr::opts_chunk$set(

# Introduction

This is a (incomplete) list of potential use cases of this software. They show what functions are required at minimum to build a valid [CLUMondo](https://www.environmentalgeography.nl/site/data-models/models/clumondo-model/) model of a certain kind.
This is a (incomplete) list of potential use cases of this software. This document show what functions are required at minimum to build a valid [CLUMondo](https://www.environmentalgeography.nl/site/data-models/models/clumondo-model/) model of a certain setup.

In this document you will first find an overview of the example data used to build the use cases and scenarios. Then, use cases are sorted by complexity and grouped by the involved land systems and the demands according to which the systems will be modified. The first group has use cases that can be run on two land systems and one demand. The second group is extension of this and includes additionally a third land system, but still only one demand. The third group is again an extension of the previous group and finally includes additionally a second demand. At the end of the document, there are examples that show more complex use cases.

There is a little note: Since CLUE can be and is used in various fields, we simply use the term land system or just system to denote the land surface descriptions, be they land use, land cover or any other system.

Also, this document is still work in progress (and we welcome any additions)!

## Example data

Let's first load the requried packages and define the path for example data.
Let's first load the required packages and define the path for example data.

```{r setup}
#| eval: false
#| eval: true
library(clueRIO)
library(tidyverse)
Expand All @@ -53,10 +58,16 @@ library(terra)
data <- system.file("test_data", package = "clueRIO", mustWork = TRUE)
```

There are various tables and raster layers used throughout this tutorial.
There are various tables and (highly simplified) raster layers used throughout this tutorial. Below we see, as an example, maps of land systems and suitability maps. Other data are generated with simple example code only when they are needed.

```{r}
# plot the rasters
(testRast <- list.files(data, full.names = TRUE))
# land systems
plot(rast(testRast[str_detect(testRast, "ls")]))
# different suitability layers
plot(rast(testRast[str_detect(testRast, "suitability")]))
```


Expand Down Expand Up @@ -2134,10 +2145,12 @@ model <- "laos"
temp <- rast("H:/rdev/clueRIO/_misc/example_data/preferences1.asc")
writeRaster(x = temp,
filename = paste0("H:/rdev/clueRIO/inst/test_data/preference1.tif"),
# filename = paste0("H:/rdev/clueRIO/inst/test_data/ls2.tif"),
filename = paste0("/media/se87kuhe/projects/rdev/clueRIO/inst/test_data/suitability3.tif"),
overwrite = TRUE,
filetype = "GTiff",
datatype = "INT1U",
# datatype = "INT1U",
datatype = "FLT4S",
gdal = c("COMPRESS=DEFLATE", "ZLEVEL=9", "PREDICTOR=2"))
```

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions vignettes/use_cases_files/libs/bootstrap/bootstrap-dark.min.css

Large diffs are not rendered by default.

2,018 changes: 2,018 additions & 0 deletions vignettes/use_cases_files/libs/bootstrap/bootstrap-icons.css

Large diffs are not rendered by default.

Binary file not shown.
10 changes: 10 additions & 0 deletions vignettes/use_cases_files/libs/bootstrap/bootstrap.min.css

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions vignettes/use_cases_files/libs/bootstrap/bootstrap.min.js

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions vignettes/use_cases_files/libs/clipboard/clipboard.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions vignettes/use_cases_files/libs/quarto-html/anchor.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions vignettes/use_cases_files/libs/quarto-html/popper.min.js

Large diffs are not rendered by default.

Loading

0 comments on commit 0537022

Please sign in to comment.