generated from NINAnor/NINA-ebook-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f366094
commit 1a4cb1e
Showing
1 changed file
with
55 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,55 @@ | ||
# NINA ebook template | ||
Template repository for creating a NINA-themed book powered by Quarto and Rendered by GitHub Actions onto GitHub Pages. | ||
The template has borrowed heavily from Jens Åström's work on the [Quarto template for NINA reports](https://github.com/NINAnor/quarto_nina_report). | ||
Also a thanks to Niccolò Cantù for the scss file with the NINA color scheme. | ||
|
||
Note: When clicking 'Use this template', remember to copy all branches, to include the GH-pgaes branch. If you forget this, see the inforamtin at the bottom of this page for how to initiate GitHub actions. | ||
|
||
## Overview | ||
|
||
The repository holds: | ||
|
||
- [`.github/workflows/quarto-render.yml`](.github/workflows/quarto-render.yml): Install, setup, and render a Quarto book using R and Python | ||
- [`_quarto.yml`](_quarto.yml): Setup the properties of the book in a minimal fashion (for more options see [Quarto: Book Structure](https://quarto.org/docs/books/book-structure.html)) | ||
- [`index.qmd`](index.qmd): Welcome page | ||
|
||
Additional files: | ||
|
||
- [`requirements.txt`](requirements.txt): List of Python Packages to install | ||
- [`DESCRIPTION`](DESCRIPTION): List of R Packages using the standard DESCRIPTION file to install with `pak`. | ||
|
||
## Publishing with GitHub Actions | ||
|
||
Included in the repository is a custom GitHub Action that will automatically render and deploy the book onto GitHub Pages. | ||
Before the first run of the GitHub Action, please make sure to use locally in terminal the following: | ||
|
||
```sh | ||
quarto publish gh-pages | ||
``` | ||
|
||
This command [initializes the `gh-pages` branch and turns on GitHub Pages for the repository](https://quarto.org/docs/publishing/github-pages.html#source-branch). | ||
|
||
If you do not run this command before the first GitHub Action is triggered, you will likely encounter the following error message in the build log: | ||
|
||
```sh | ||
ERROR: No _publish.yml file available (_publish.yml specifying a destination required for non-interactive publish) | ||
``` | ||
|
||
To avoid this issue, please make sure to run the GitHub Action locally so that GitHub can render and publish your Quarto document after every push to the repository. | ||
Years: 2017-2022 | ||
Main response variable: moss height | ||
Main explanatory variables: Disturbance category, yearly climate variables, water table depth | ||
|
||
Species data only for 2020-2022 | ||
18 quadrats 2017-2020, each with its own adjacent water table well; 28 quadrats for 2021 and 2022 | ||
Water table depth for all years, but maybe some data missing from autumn 2019. | ||
Climate data from local weather stations. | ||
|
||
_Nr 29 and 30 should be exluded from 2021 and 2022_ | ||
|
||
`data/growthData.xlsx` | ||
Tabs: one per year. Combine these with rbind() | ||
Columns: | ||
- **ID**. Unique for each pin, but not each measurement. _old/new_ means the pin has been replaces, and you cannot compare them. | ||
- **Plot_no**. Vegetation quadrats, 1-28(-30). | ||
- **Pin_nr**. 1-16, unique within each quadrat. Cranked wire / Shpagnum brush. | ||
- **Treatment**. | ||
- M = intact bog. | ||
- T = near peat exatraction site (T1 = 5 m, and T2 = 15 meters away) | ||
- R = near ditch (R1 = 5 m away; R2 = 15 m away) | ||
- K = edge of mire, adjacent to grassland | ||
- Hollow | ||
- Hummock | ||
|
||
M, T, R, and K are all homogeneous bog lawn. | ||
|
||
Hollow and Hummock are microtopographic variation, and should be moved to another column. | ||
They are located close to the centre of the bog, but it might not work to class them as M. | ||
Hollows are not found close to ditches and other hydrological disturbances. | ||
|
||
- **HeigthSPRING_*** | ||
- W = west | ||
- E = east | ||
- 1,2 and 3 refers to repeated measured on the same pin + direction combination, done by different people, or by the same person but from north and south. | ||
|
||
- **HeigthFALL_*** | ||
- same as above | ||
- **HeightSUMMER_*** | ||
- only for 2018 and 2019 | ||
|
||
- **Date*** | ||
- dd.mm.yyyy | ||
- **Observer*** | ||
- **Notes*** | ||
- **Comments*** | ||
|
||
|
||
`data/*shp` | ||
- grøfter | ||
- hostamyra_myrmassiv | ||
- torvtak | ||
- vegetasjonsruter19-30 | ||
- veipunkter_vannbrønner_ruter_2017 | ||
|