Skip to content

Commit e0ed46b

Browse files
committed
Updating README
1 parent 4e2ea70 commit e0ed46b

1 file changed

Lines changed: 6 additions & 44 deletions

File tree

README.md

Lines changed: 6 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
ohi-global
22
==========
33

4-
### Global assessments (EEZ, Antarctica, and High Seas) and scenarios (2012-2016) of the Ocean Health Index
4+
### Global assessments (EEZ, Antarctica, and High Seas) and scenarios of the Ocean Health Index
55

66
#### Anatomy of the file structure
77

88
General information about file structure is here: http://ohi-science.org/manual/#file-system-organization
99

1010
Three OHI assessments (for a range of scenario years) are included in this folder:
1111

12-
* eez (scenarios: 2012 - 2016): OHI for 220 country/territorial EEZ regions, this is typically considered the "OHI global assessment"
12+
* eez (scenarios: 2012 - 2017): OHI for 220 country/territorial EEZ regions, this is typically considered the "OHI global assessment"
1313
* antarctica (scenarios: 2014 - 2015): OHI for Antarctica CCAMLR regions (includes the high seas/FAO and EEZ regions)
1414
* high seas (scenarios: 2014 - 2015): OHI for high seas regions (FAO regions without the EEZ regions or Antarctica/CCAMLR regions)
1515

@@ -18,8 +18,8 @@ Additional files/folders include:
1818

1919
* eez_layers_meta_data: Database for the EEZ data layers (data sources, names, etc.) and functions to create different data formats
2020
* global_supplement: Descriptions of data layers and goals
21-
* global (2014-2016): Post assessment analysis and visualization of data
22-
* calculate\_scores_??.R: These files provide the code to calculate scores for the corresponding OHI assessment
21+
* global (2015-2017): Post assessment analysis and visualization of data
22+
* calculate\_scores_??.R: These files provide the code to calculate scores for the corresponding OHI assessment (the calculate_scores.R for the eez regions is located in the eez folder)
2323
* layers\_??.csv: These files provide the location of the data layers used to calculate the OHI assessments. This file is created by data and functions in the eez_layers_meta_data folder, and they are used by calculate_scores_??.R.
2424
* other files can be ignored
2525

@@ -35,43 +35,5 @@ Important files within the "eez", "antarctica", and "high seas" folders include:
3535
- pressure_categories: Defines the pressure category for each pressure layer
3636
- resilience_matrix.csv: Indicates which resilience layers affect which goals
3737
- resilience_categories: Defines the resilience category for each resilience layer
38-
39-
40-
### Creating a new scenario within an assessment (e.g., eez2012, eez2016, etc.)
41-
1. Copy the folder of a previous scenario and change the year
42-
2. Update the eez_layers_meta_data/layers_eez_file_locations.csv with the file paths and names of the data for each scenario
43-
3. Update conf/goals.csv with appropriate status_year information (which year in the data layer is used for the scenario)
44-
4. Update the calculate_scores_??.R as follows:
45-
- Add the "scenario" to the scenario list (we might want to move this information to a table at some point):
46-
- And update the sync functions so the functions.R files stay consistent
47-
48-
```
49-
# scenario list (need to add new scenarios here)
50-
scenarios = list(
51-
eez2015 = list(
52-
layer = 'layers_eez',
53-
fld_dir = 'dir_2015a',
54-
fld_fn = 'fn_2015a',
55-
f_spatial = c('../ohiprep/Global/NCEAS-Regions_v2014/data/regions_gcs.js'),
56-
do = T),
57-
eez2014 = list(
58-
layer = 'layers_eez',
59-
60-
```
61-
62-
```
63-
### sync functions.R:
64-
# overwrite eez2012, eez2014, eez2015, with eez2013
65-
for (dir in c('eez2012','eez2014', 'eez2015')){
66-
stopifnot(file.copy('eez2013/conf/functions.R', file.path(dir, 'conf/functions.R'), overwrite=T))
67-
}
68-
# overwrite antarctica2015 with antarctica2014
69-
for (dir in c('antarctica2015')){
70-
stopifnot(file.copy('antarctica2014/conf/functions.R', file.path(dir, 'conf/functions.R'), overwrite=T))
71-
}
72-
# overwrite highseas2015 with highseas2014
73-
for (dir in c('highseas2015')){
74-
stopifnot(file.copy('highseas2014/conf/functions.R', file.path(dir, 'conf/functions.R'), overwrite=T))
75-
}
76-
77-
```
38+
- scenario_data_years.csv: Links the scenario year to the corresponding year of the data for each data layer
39+

0 commit comments

Comments
 (0)