Opened 3 years ago

Last modified 3 years ago

#151 new enhancement

Clarification of use of standard region names in "region" variables. — at Initial Version

Reported by: martin.juckes Owned by: cf-conventions@…
Priority: medium Milestone:
Component: cf-conventions Version:
Keywords: Cc:

Description

The CF standard name region has the current description "A variable with the standard name of region contains strings which indicate geographical regions. These strings must be chosen from the standard region list." This description implies that the variable should be of character type, but it is often more convenient to have an integer variable and make a clear link to the region names using flag_values and flag_meanings. The proposal is to clarify the definition so that either usage is acceptable and include an example of the latter usage in the convention text. It is also proposed that an appendix be added to the CF Convention text to state clearly any constraints on file meta-data which are implied by the CF Standard Name definitions, so that it is possible to test such constraints in the CF checker.

New description for CF standard name "region"

A variable with the standard name of region must have values associated with geographical regions from the CF standard region list, either as a character variable using the region names directly or as an integer variable with values linked to region names through flag_values and flag_meanings attributes.

New usage example in CF Convention text

The following should be placed at the end of 6.1.1, after example 6.2

A variable with standard name 'region' may also be of integer type and use 'flag_values' and 'flag_meanings' attributes to express the relationship between the integers and the region names:

integer basin(basin);
       standard_name: region;
       flag_values: '1 2 3';
       flag_meanings:'atlantic_arctic_ocean indo_pacific_ocean global_ocean';
......
values::
   basin: 1, 2, 3;

New Appendix Section

Change "Appendix B: Standard Name Table Format" to:

Appendix B: Standard Names

B.1: Standard Name Table Format

.....

and

B.2 Constraints for specific standard names

B.2.1: region

Variables with standard name region must be one of:

  • type character, with values taken from the CF standard region list;
  • type integer, with flag_values and flag_meanings attributes. The flag_meanings attributes must be a space separatd list of values from the CF standard region list (see example 6.2).

Change History (0)

Note: See TracTickets for help on using tickets.