update README

laura-summerauer · Dec 14, 2020 · aa57c48 · aa57c48
1 parent 71dac03
commit aa57c48
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 6 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -13,9 +13,10 @@ knitr::opts_chunk$set(echo = FALSE)
 
 # Overview 
 
-This is a repository with codes and data, basing on the manuscript "Filling a key gap: a soil spectral library for central Africa". The material within this repository helps to reproduce our optained results. 
-
-```{r}
-
-```
+This is a repository with codes and data, basing on the manuscript "Filling a key gap: a soil spectral library for central Africa". The material within this repository allows to reproduce our optained results. 
 
+- **R**: used R scripts 
+- **R/Rhelper**: used R functions
+- **data/reference_data**: reference data for the two soil spectral libraries (SSL); our central African SSL called CSSL and the AfSIS SSL
+- **data/metadata**: metadata for the two soil spectral libraries (SSL); our central African SSL called CSSL and the AfSIS SSL used for the modeling
+- **data/spectra_data**: spectral data for the two soil spectral libraries (SSL); our central African SSL called CSSL and the AfSIS SSL
diff --git a/README.md b/README.md
@@ -11,4 +11,17 @@ Baert, Sebastian Dötterl and Johan Six
 
 This is a repository with codes and data, basing on the manuscript
 “Filling a key gap: a soil spectral library for central Africa”. The
-material within this repository helps to reproduce our optained results.
+material within this repository allows to reproduce our optained
+results.
+
+  - **R**: used R scripts
+  - **R/Rhelper**: used R functions
+  - **data/reference\_data**: reference data for the two soil spectral
+    libraries (SSL); our central African SSL called CSSL and the AfSIS
+    SSL
+  - **data/metadata**: metadata for the two soil spectral libraries
+    (SSL); our central African SSL called CSSL and the AfSIS SSL used
+    for the modeling
+  - **data/spectra\_data**: spectral data for the two soil spectral
+    libraries (SSL); our central African SSL called CSSL and the AfSIS
+    SSL