Skip to content

Commit 2b87b84

Browse files
Update README
Remove any link to Belgium. Correct any wrong link or outdated description left by copy pasting the README from https://github.com/trias-project/occ-cube-alien/edit/master/README.md.
1 parent 845a883 commit 2b87b84

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

β€ŽREADME.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Rationale
44

5-
This repository contains the functionality to process occurrence data and create aggregated **occurrence data cubes** at species level for some European countries. An occurrence data cube is a multi-dimensional array of values. In our context we have three dimensions, ``N = 3``:
5+
This repository contains the functionality to process occurrence data and create aggregated **occurrence data cubes** at species level for European countries. An occurrence data cube is a multi-dimensional array of values. In our context we have three dimensions, ``N = 3``:
66

77
1. taxonomic (taxon)
88
2. temporal (year)
@@ -52,7 +52,7 @@ taxonKey | scientificName | numberOfOccurrences | taxonRank | taxonomicStatus
5252

5353
See https://doi.org/10.15468/dl.rej1cz for more details. Note: the table above is just an example and can be outdated.
5454

55-
By aggregating we would loose this information, so we provide aside the cubes, e.g. `cube_belgium.tsv`, a kind of taxonomic compendiums, e.g. `cube_belgium_taxa.tsv`. They include for each taxa in the cube all the synonyms or infraspecies whose occurrences contribute to the total count. Differently from data cube of alien species, these data cubes are completely built upon the taxonomic relationships of [GBIF Backbone Taxonomy](https://www.gbif.org/dataset/d7dddbf4-2cf0-4f39-9b2a-bb099caae36c). Both data cubes and taxonomic compendiums are saved in `data/processed`.
55+
By aggregating we would loose this information, so we provide aside the cubes, e.g. `be_species_cube.csv`, a kind of taxonomic compendiums, e.g. `be_species_info.csv`. They include for each taxa in the cube all the synonyms or infraspecies whose occurrences contribute to the total count. Differently from data cube of alien species, these data cubes are completely built upon the taxonomic relationships of [GBIF Backbone Taxonomy](https://www.gbif.org/dataset/d7dddbf4-2cf0-4f39-9b2a-bb099caae36c). Both data cubes and taxonomic compendiums are saved in `data/processed`.
5656

5757
For example, _Aedes japonicus (Theobald, 1901)_ is an accepted species present in the Belgian cube: based on the information stored in `occ_belgium_taxa.tsv`, its occurrences include occurrences linked to the following taxa:
5858
1. [Aedes japonicus (Theobald, 1901)](https://www.gbif.org/species/1652212)
@@ -75,33 +75,32 @@ The repository structure is based on [Cookiecutter Data Science](http://drivenda
7575
β”‚ └── processed : occurrence data cubes and related taxa informations GENERATED
7676
β”‚
7777
└── src
78-
β”œβ”€β”€ belgium
79-
β”œβ”€β”€ 1_download.Rmd : Script to trigger a download of occurrences in Belgium
80-
β”œβ”€β”€ 2_create_db.Rmd : Script to genereate a sqlite file and perform basic filtering
81-
β”œβ”€β”€ 3_assign_grid.Rmd : Script to assign cell code to occurrences
82-
β”œβ”€β”€ 4_aggregate.Rmd : Script to aggregate data and make the Belgian data cube
78+
β”œβ”€β”€ 1_download.Rmd : Script to trigger a download of occurrences in a country
79+
β”œβ”€β”€ 2_create_db.Rmd : Script to genereate a sqlite file and perform basic filtering
80+
β”œβ”€β”€ 3_assign_grid.Rmd : Script to assign cell code to occurrences
81+
β”œβ”€β”€ 4_aggregate.Rmd : Script to aggregate data and make the Belgian data cube
8382
```
8483

8584
## Installation
8685

8786
Clone this repository to your computer and open the RStudio project file, `occ-processing.Rproj`.
8887

89-
### Generate occurrence data cube for Belgium
88+
### Generate occurrence data cube
9089

91-
You can generate the Belgian occurrence data cube by running the [R Markdown files](https://rmarkdown.rstudio.com/) in `src/belgium` following the order shown here below:
90+
You can generate a national occurrence data cube by running the [R Markdown files](https://rmarkdown.rstudio.com/) in `src` following the order shown here below:
9291

9392
1. `1_download.Rmd`: trigger a GBIF download and add it to the list of triggered downloads
9493
2. `2_create_db.Rmd`: create a sqlite database and perform basic data cleaning
9594
3. `3_assign_grid.Rmd`: assign geographic cell code to occurrence data
9695
4. `4_aggregate.Rmd`: aggregate occurrences per taxon, year and cell code, the _Belgian occurrence data cube_
9796

98-
In the aggregation step, we also create a data cube at class level. The data cubes are authomatically generated in folder `/data/processed/`.
97+
The data cubes are authomatically generated in folder `/data/processed/`.
9998

10099
Install any required packages, first.
101100

102101
## Contributors
103102

104-
[List of contributors](https://github.com/trias-project/unified-checklist/contributors)
103+
[List of contributors](https://github.com/trias-project/occ-cube/contributors)
105104

106105
## License
107106

0 commit comments

Comments
Β (0)