In GaelMariani/NCSSDGproj: What the Package Does (One Line, Title Case)

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "README-"
)
# Please put your title here to include it in the file below.
Title <- "Data and Code for NCS - SDG analyses"

Co-benefits and trade-offs between Natural Climate Solutions and Sustainable Development Goals

This repository contains data and code used to obtain results of the paper Mariani et al. (202?) - Co-benefits and trade-offs between Natural Climate Solutions and Sustainable Development Goals submitted in Nature Climate Change.

Contents

:file_folder: rawdata directory contains the table of positive and negative links used to perform all analysis. See Material & Methods section of the paper for more details. This directory also contains SDG's and NCS's icons use in the figures of the paper.

:file_folder: results directory contains all .RData files generated during the analyses.

:file_folder: R directory contains the functions used to perform all the analyses. The 4 main importants .R files are:

1. :open_book: read_data.R contains functions to read data.
2. :package: format_data.R contains functions to format the data in the desired format to make the analyses and figures.
3. :microscope: analysis.R contains functions to perform statistical analyses, mainly null models and correspondance analysis.
4. :bar_chart: plot_data.R contains all functions to obtain plots in the paper.

:file_folder: figures directory contains all figures (format .png) in the paper.

:file_folder: make_results contains detailled R scripts to produce figures and run analysis using all functions in R.

The :briefcase: make.R file allows to produce all analyses and render the corresponding plots by running R scripts in make_results.

The :hammer: dev_history.R file allows to rebuild our research compendium from scratch.

How to run it?

This research compendium has been developed using the statistical programming language R. To work with the compendium, you will need installed on your computer the following softwares:

• R: https://cloud.r-project.org/
• RStudio: https://rstudio.com/products/rstudio/download/
• Git: https://git-scm.com/
• Create a GitHub account: https://github.com/

You can download the compendium by cloning this repository. You can follow this tutorial, section "Clone the repository with RStudio" to clone the repository.

Once the compendium is cloned, follow these steps:

1. open the .Rproj file in RStudio.
2. open make.R and run it to produce all analyses.

Note that R version 3.6.2 or later is required. Run this command utils::sessionInfo() to check your R version.
You can uptade your R version here.

Session Info

utils::sessionInfo()

Licenses

Text and figures: CC-BY-4.0

Code: See the DESCRIPTION file

Data: CC-0 attribution requested in reuse

GaelMariani/NCSSDGproj documentation built on April 1, 2024, 9:18 a.m.