index.Rmd

---
title: "LandR Manual"
subtitle: "`r paste('v.', Sys.getenv('LANDR_MAN_VERSION'))`"
author: |
  Edited by: Ceres Barros, Alex M. Chubaty, Ian M. S. Eddy, Eliot J. B. McIntire
date: "Last updated: `r Sys.Date()`"
description: "A manual for the LandR ecosystem of SpaDES modules"
documentclass: krantz
site: bookdown::bookdown_site
github-repo: PredictiveEcology/LandR-Manual
url: 'https\://predictiveecology.github.io/LandR-Manual'
knit: "bookdown::render_book"
bibliography:
  - citations/referencesLandRManual.bib
csl: citations/ecology-letters.csl
biblatexoptions: [refsegment=chapter]
link-citations: true
cover-image: "figures/LandRHex.png"
always_allow_html: true
colorlinks: yes
graphics: yes
fontsize: 11pt
lot: yes
lof: yes
---

<!-- manual version TODO: link to date and commit of manual/project repo -->

# Preface {-}

```{r figLandRHex, eval = TRUE, echo = FALSE, fig.align = 'center', fig.dim = c(10,10)}
knitr::include_graphics(Require::normPath(c("figures/LandRHex.png")))
```

LandR is a collection of `SpaDES` modules [see @ChubatyMcIntire2019] aimed at
simulating forest dynamics across large spatial scales, while taking into
account various disturbances that affect them (e.g., wildfire and climate
change), as well as interactions with other components of forest systems, such
as bird communities and ungulates (via changes in the habitat of these species),
and carbon cycling.

The present manual is a "live" document, in that it grows and changes according to
the existing number of LandR modules, as well as their development. In addition,
"sub-manuals" may be produced describing particular collections of LandR modules
used for a simulation project or a group of similar modules -- e.g., a LandR 
Biomass manual would describe only the LandR modules that are essential for the
simulation of the vegetation components of forest succession, excluding 
disturbances or carbon cycling.

This manual does not cover the `SpaDES` toolkit, which we use to create and run
LandR modules. To learn more about `SpaDES` go to the [SpaDES
webpage](https://spades.predictiveecology.org/).

**Previous versions:**

```{r, eval = TRUE, echo = FALSE, results = 'asis'}
allPDFs <- list.files("archive/pdf", full.names = TRUE)
allPDFs <- grep(Sys.getenv('LANDR_MAN_VERSION'), allPDFs, invert = TRUE, value = TRUE)
versionNames <- sub("\\.pdf", "", gsub("(-|_)", " ", basename(allPDFs)))
versionNames <- sub("[m|M]anual", "Manual", versionNames)
pdfURLs <- paste0("https://github.com/PredictiveEcology/LandR-Manual/raw/main/", allPDFs)

## text to render
cat(paste0("-   [", versionNames, "](", pdfURLs, ")\n"))
```

<!-- -   [LandR Manual v. 1.0.0](https://github.com/PredictiveEcology/LandR-Manual/raw/main/archive/pdf/LandR-manual-v1.0.0.pdf) -->
<!-- -   [LandR Manual v. 1.0.1](https://github.com/PredictiveEcology/LandR-Manual/raw/main/archive/pdf/LandR-manual-v1.0.1.pdf) -->
<!-- -   [LandR Manual v. 1.0.2](https://github.com/PredictiveEcology/LandR-Manual/raw/main/archive/pdf/LandR-manual-v1.0.2.pdf) -->