På denne nettressursen samles informasjon, dokumentajon og resultater relatert til utarbeidelsen av et naturregnskap i Nordre Follo kommune i 2022.
Klikk her for å gå til en lesevennlig fremstilling.
Bilde: Økologisk tilstand sier noe om hvilken påvirkning menneskelig aktivitet har på økosystemens integritet. Edward Clack / Aerial view of Scrub Lane and Belfairs Nature Reserve
.github Contains the GitHub Actions workflow. Usually you'll not need to edit anything here, unless you make use of a new package somewhere - then you need to add that package to the list.
R Contains R scripts that are not rendered as book chapters. This includes all the indikcator documentation and analyses.
data Contains raw data used for any of the analyses.
figuresContain images that are rendered somewhere in the book on in this readme file.
manShort for manual. Contains descriptions files (if any).
output Contains data produces by scripts inside this repo.
Book chapters are numbered rdm files. The first chapter is called index.Rmd.
This is a guide for how NINA employees can work collaboratively to write the Naturregnskap book.
Overview. Everybody that will interact with and propose changes to the github repository will follow a workflow that involves Pull Requests, og PRs for short. Admins will also do this, thus keeping the main branch and the web site stable. Pull requests will be managed by Anders L. Kolstad. Some users will not be comfortable with using github and these can ally with another user or contact Anders for help.
Fork the repo.
Contributors are asked to fork the NINAnor/naturregnskap repository to their own github user account.
Clone your fork down to your local computer.
Start by copying the repo's url.
In RStudio, create a new project - from version control - from GitHub, and paste you url there.
Make you edits to this project (to the main branch or any branch); commit; and push.
Go to the NINAnor version of the repo and perform a PR from there.
Now people can review your edits and suggest changes before merging them with the main branch in the NINAnor repo. If you make new commits now, after submitting a PR, these commits will become part of the PR. You do not need to create a new PR or delete the first one.
Now, importantly, everytime before you start working on your forked version, you need to update it with the main *base' repository at NINAnor. To to this, go to your forked repo at GitHub and click Fetch upstream.
Return to RStudio, chose your forked project, and pull down from github.
Optional workflow based on branches.
As we are not that many collaborators, you can use branches, and not forks, for our PRs.
It is still recommended that you use forks as explained above.
If you decide to work via development branches, you can start off by cloning the repo to you local machine and initiate a new branch.
Make your edits here; commit; push; and do a PR.
Branches are deleted after every merge with the main branch.
You should then delete the corresponding local branch as well, in RStudio.
In the shell (Tools - Shell..), type git branch -d NAME-OF-Your-BRANCH.
If you experience a build up of remote branches that you know are deleted on GitHub, you can prune them from the list in RStudio with this shell command: git fetch -p.
Checkout the main branch and to a pull before creating another development branch.
To work using branches, before starting, make sure you're added to the github repo with write admissions. Email Anders Kolstad for help.
Local serving and Continous Integration using GitHub Actions.
You can set up a live rendering (visualisation) that shows how your edits will look like when published. See R/serve.R.
You do not need to render html-files locally.
Just save the .Rmd files you are working on.
A GitHub actions workflow is set up for continuous integration, meaning the Rmd-files are rendered to html on a github-hosted server.
These are then put in the gh-pages branch that hosts the web site.
In case you for some reason decided to render the book locally you can delete everything again, all the html and md files, using the clean_book() function.
When you're happy with your edits you can commit you changes (should be done quite frequently anyways) and push to the remote (i.e. GitHub) and then you create a pull request here. The moderator (currently Anders L. Kolstad) will need to accept the edits before the are merged to the main branch and published online in the book.
All the work that goes into the ecosystem account should be documented somewhere in this repo.
All background analyses should be in English, and all the text that shows in the book should be in Norwegian.
If you are working on something like an indicator for ecological condition, you can have an rmd-file in R/conditionIndicators and then render these to pdf if you like and put them in a subfolder R/conditionIndicators/pdfOutput.
You can then link to the pdf when writing about this indicator inside the book.