Skip to content

Latest commit

 

History

History
66 lines (46 loc) · 2.54 KB

README.md

File metadata and controls

66 lines (46 loc) · 2.54 KB
Raw

compendium

License: GPL (>= 2) LifeCycle Dependencies

This repository contains the research compendium for the project “PROJECT TITLE”. It contains all the code required to import, format, and integrate the data needed for this project, as well as the code used to perform the analyses, figures, and the project report.

How to cite

Please cite this research compendium as follows:

{{ PLEASE ADD A CITATION }}

Content

This research compendium is structured as follows:

  • data/: contains the data for the assessment.

    • aoi/: spatial data on the area of interest
    • basemap/: spatial data used to generate the maps of the assessment
    • config/: configuration files with parameters used throughout the project (e.g. spatial projection, colors, bounding box, etc.)
    • grid/: study grid for the project
    • pipedat/: outputs from the pipedat package workflow, if used.

  • docs/: contains the html version of the report and other publications of the project

  • figures/: contains all the figures generated for the project

  • man/: contains the documentation for all R functions that are part of the research compendium

  • output/: contains all the outputs from the project

  • R/: contains R functions developped for the assessment

  • pubs/: contains the R Markdown version of the project report and other publications

  • DESCRIPTION: research compendium metadata (authors, date, dependencies, etc.)

  • README.Rmd: description of research compendium