README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->


```{r, include = FALSE}
knitr::opts_chunk$set(collapse  = TRUE,
                      comment   = "#>",
                      fig.path  = "man/figures/",
                      out.width = "100%")
```



paper-template-repo <img src="man/figures/compendium-sticker.png" align="right" style="float:right; height:120px;"/>
=========================================================

<!-- badges: start -->
<!-- badges: end -->

# To use the template
Click the green "use this template" button in the top right of this GitHub page. 
In your new project:

1. Use Ctrl-Shift-F to find all uses of PackageName and replace it with the name of the repo you created. If you are not part of LandSciTech first replace LandSciTech/PackageName with your GitHub user name and then replace PackageName.
1. Rename the .Rproj file to have the same name as the repo.
1. Fill in metadata in the DESCRIPTION
1. update the README.Rmd and knit it (and delete this text).

<p align="left">
  • <a href="#overview">Overview</a><br>
  • <a href="#features">Features</a><br>
  • <a href="#content">Content</a><br>
  • <a href="#installation">Installation</a><br>
  • <a href="#usage">Usage</a><br>
  • <a href="#citation">Citation</a><br>
  • <a href="#contributing">Contributing</a><br>
  • <a href="#acknowledgments">Acknowledgments</a><br>
  • <a href="#references">References</a>
</p>



## Overview

This research compendium... **{{ DESCRIBE YOUR PROJECT }}**



## Features

The main purpose of this compendium is to... **{{ DESCRIBE THE MAIN FEATURES }}**



## Content

This repository is structured as follows:

- [`DESCRIPTION`](https://github.com/LandSciTech/PackageName/tree/main/DESCRIPTION):
contains project metadata (authors, date, dependencies, etc.)

- [`make.R`](https://github.com/LandSciTech/PackageName/tree/main/make.R):
main R script to run the entire project

- [`R/`](https://github.com/LandSciTech/PackageName/tree/main/R):
contains R functions developed for this project

- [`analyses/`](https://github.com/LandSciTech/PackageName/tree/main/analyses):
contains source code for the paper and scripts that are part of the analysis but not run in the paper. Also includes templates that are used to render the paper. 

- [`data/`](https://github.com/LandSciTech/PackageName/tree/main/data):
contains data needed to run the project. raw-data should contain unmodified source data, derived-data should contain modified versions of the data

- [`figures/`](https://github.com/LandSciTech/PackageName/tree/main/figures):
contains figure files including those generated by rendering the paper





## Installation

To install this compendium:

- [Fork](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) 
this repository using the GitHub interface.
- [Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) 
your fork using `git clone fork-url` (replace `fork-url` by the URL of your fork). 
Alternatively, open [RStudio IDE](https://posit.co/products/open-source/rstudio/) 
and create a New Project from Version Control.



## Usage

Launch the [`make.R`](https://github.com/LandSciTech/PackageName/tree/main/make.R)
file with:

```{r eval=FALSE}
source("make.R")
```

**Notes**

- All required packages listed in the `DESCRIPTION` file will be installed (if necessary)
- All required packages and R functions will be loaded
- Some analyses listed in the `make.R` might take time



## Citation

Please use the following citation: 

> **{{ ADD A CITATION }}**



## Contributing

All types of contributions are encouraged and valued. For more information, 
check out our [Contributor Guidelines](https://github.com/LandSciTech/PackageName/blob/main/CONTRIBUTING.md).

Please note that this project is released with a 
[Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). 
By contributing to this project, you agree to abide by its terms.



## Acknowledgments

**{{ OPTIONAL SECTION }}**



## References

**{{ OPTIONAL SECTION }}**