Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AlbanSagouis authored Jun 7, 2023
1 parent cb3e533 commit c69a6da
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ Research project aggregating biodiversity data from checklists. Child project fr
## Description
This research compendium regroups scripts used to download, re-structure and aggregate data sets to constitute a large meta-analysis of communities sampled at least twice, 10 years apart or more. It is a child project from chase-lab/homogenisation and a brother project to chase-lab/metacommunity-surveys and chase-lab/checklist_change.

## Data
Raw and aggregated data tables are provided. Aggregated data are in data/communities.csv and data/metadata.csv and column definitions are given in definitions_communities.txt and definitions_metadata.txt.

## Reproducibility and R environment
### Installation

After downloading or cloning this repository, run these scripts in order to download raw data, wrangle raw data and merge all data sets into one long table.
To ensure reproducibility, the working environment (R version and package version) were documented and isolated using the package `renv` (https://rstudio.github.io/renv/index.html). By running `renv::restore()`, `renv` will install all missing packages at once. This function will use the renv.lock file to download the same versions of packages that we used and install them on your system.

After downloading or cloning this repository, run these scripts in order to wrangle raw data and merge all data sets into one long table.
```
renv::restore()
source('./R/1.0_wrangling_raw_data.r')
source('./R/2.0_merging_long-format_tables')
```
And finally, as described below: `renv::restore()`

### Containerisation

To ensure that the working environment (R version and package version) are documented and isolated, the package `renv` (https://rstudio.github.io/renv/index.html) was used. By running `renv::restore()`, `renv` will install all missing packages at once. This function will use the renv.lock file to download the same versions of packages that we used.

0 comments on commit c69a6da

Please sign in to comment.