This GitHub repository is intended to store the versioned code and other text files, including csv, used to prepare the data layers for the Ocean Health Index. We have seperate methods for handling files based on type:
text
any scripts, especially R or Python, and other text files, like READMEs or csv, used to generate data. All files must be less than 100 MB and are preferably text. These files will be versioned using GitHub and most often generated using RStudio. To see why we chose this software, see Software Features.binary
all other files, particularly binary non-text files which are larger, especially anything 50 MB or larger. These files will be stored on our file server neptune.nceas.ucsb.edu, where backups are performed (nightly, weekly, monthly) and not here in the GitHub repository.
For help setting up the software, see Setup.
Folders herein should generally be organizied like so:
[study area]/[provider]-[product]_[version]
where:
study area
geographic extent of data corresponding to intended OHI study area of analysisprovider
original provider, which is NCEAS for custom productsproduct
basic description of what the data product isversion
for NCEAS products:- product version OR the most recent year of the whole data product
- subsets of this data product can then be put in the data folder annexed by the OHI assessment year
All entries above should be in CamelCase.
All CamelCase top level folders indicate the study area which correspond to the prefix on neptune's folders:
AQ
AntarcticaBR
BrazilCC
CaliforniaCurrentFJ
FijiGL
GlobalMA
Massachusetts
Other folders are:
src
source files for general R and Python codewiki
files, particularly images, used by the ohidata wiki