Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@
^\.Rproj\.user$
^\.github$
^test_docker.sh$
^\.positai$
^\.claude$
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,4 @@ libs/
*_libs
output/
renv/library
.positai
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,33 @@ editor_options:

Thank you for considering to contribute to this repository!

## Returning to protocolsource?

Skip this section if you haven't contributed to the protocolsource repository before.

If it's been sometime since you contributed to the protocolsource repository, here are some helpful tips to get you started again.

First, locate your local copy (a _clone_ in GitHub parlance) of the repository on your laptop and open the Rstudio project by opening the `protocolsource.Rproj` file.
It's likely that you need to update two things: (i) `git`, and (ii) the `renv` package management.

To check if your local `git` _clone_ is aligned with [protocolsource repository](https://github.com/inbo/protocolsource/), run the following `git` commands in the `Terminal` pane:

- Situation 1: you continue working on the same protocol branch, but it has been some time:
- make sure you are in your local branch `git checkout <protocolcode>` (replace `<protocolcode>` by your protocolcode, e.g. `sfp-456-nl`).
- then run, `git pull origin main` (this will merge changes that were done in the remote `main` branch that you did not yet have locally into your `<protocolcode>` branch)
- after updating `renv` (see below), you can continue working on your protocol

Comment thread
hansvancalster marked this conversation as resolved.
- Situation 2: you want to start working on a new protocol or update an existing protocol:
- `git checkout main` (this will switch to the `main` branch)
- `git pull` (this will fetch work done on the remote `main` branch that is not yet in your local `main` branch and include it in your local `main` branch)
- after updating `renv` (see below), you can make or update a protocol following the instructions

Comment thread
hansvancalster marked this conversation as resolved.
After this is done: restart R (CTRL+SHIFT+F10).
Then, check the `renv` status by running `renv::status()` in the `Console` pane.
If this tells you `No issues found -- the project is in a consistent state.`, you are good to go.
If not, you will need to follow the instructions and update the packages: run `renv::restore()`.
When this succeeded, you can proceed to the [workflow](#workflow) section for further guidance.

## Setup your local repository

Are you a first-time GitHub user?
Expand Down
6 changes: 3 additions & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ RUN apt-get update \
&& rm -rf /var/lib/apt/lists/*

## Install pandoc
RUN wget https://github.com/jgm/pandoc/releases/download/3.4/pandoc-3.4-1-amd64.deb \
&& dpkg -i pandoc-3.4-1-amd64.deb \
&& rm pandoc-3.4-1-amd64.deb
RUN wget https://github.com/jgm/pandoc/releases/download/3.8.3/pandoc-3.8.3-1-amd64.deb \
&& dpkg -i pandoc-3.8.3-1-amd64.deb \
&& rm pandoc-3.8.3-1-amd64.deb

## Copy R profile
COPY docker/Rprofile.site $R_HOME/etc/Rprofile.site
Expand Down
Loading
Loading