API-Reference.md

+> **Note: still not complete! probably tomorrow**
+
 This page lists all available functions and classes in the 
 ICOADS R HOSTACE toolbox.
 
 **Workflow**
+____________
 
 Script | Description 
 -------- |:------------
@@ -13,13 +16,11 @@ Script | Description
 `new_get_pairs.R`   | Duplicate record identification within the ship data. Pairs the reports as duplicate if they have associated ship `ID`s. The candidate pairs are then selected according to i) the number of matching elements (similar content of variables within a specific tolerance), ii) the `DCK`s, and iii) a comparison of the `ID`s.
 `new_get_dups.R`   | Counts the number of duplicated records and flags the best according to a [quality control criteria](Workflow/quality-control). Groups duplicated records by common `callsings`. 
 `new_merge_ids_year.R` | Links `ID`'s into classes. Ship tracks of the linked `ID`'s are then checked. Reports that fail the track check are flagged as the worst duplicate. Uses a shipping tracking alogrithm from [**imma**.](https://git.noc.ac.uk/brecinosrivas/icoads-r-hostace/-/wikis/How-to-install#install-dependencies-with-conda-all-platforms) 
-`clean_data.R`   | Unclear 
-`clean2track.R`   | Forms ship tracks for linked IDs. Unclear.
-
-**Input/Output**
-
+`clean_data.R`   | ---. 
+`clean2track.R`   | Forms ship tracks for linked `ID`s. --.
 
 **Utils**
+____________
 
 Function | Description 
 -------- |:------------
@@ -47,3 +48,91 @@ Function | Description
 `print_id_match_info.R`   | 
 `read_rdsfiles.R`   | 
 `write_dup_func.R`  | 
+
+**ICOADS variables used**
+________________
+Code | Description 
+-----: |:------------
+`ah`   | high cloud amount
+`am`   | middle cloud amount
+`at`   | air temperature
+`c1`   | country recruited ship
+`c1m`  | recruiting country
+`cce`  | change code
+`che`  | high cloud type 
+`cle`  |  low cloud type
+`cme`  |  middle cloud type
+`d`  |    wind direction (true)
+`dck`  |  deck
+`dpt`  |  dew-point temperature
+`ds`  |   ship course
+`dups`  | dup status
+`dy`    | day UTC  
+`eoh`   | exposure of hygrometer
+`es`    | thickness of *Is* (ice accretion on ship)
+`he`    | 
+`hop`    | height of visual observation platform
+`hr`     | hour UTC1
+`id`     | identification/callsign  
+`ii`     | ID indicator
+`immv`   | IMMT version (International Maritime Meteorological Tape)
+`ir`     | indic. for precip. data
+`irf`    | intermediate reject flag
+`is`     | ice accretion on ship
+`lat`    | latitude
+`lon`    | longitude
+`lz`     | 2°×2° landlocked flag
+`mds`    | metadata source
+`mo`     | month UTC
+`n`      | cloud amount
+`ne`     |
+`nh`     |
+`nhe`    |
+`nid`    |
+`oav`    |
+`oaz`    |
+`ocv`    |
+`ocz`    |
+`onv`    |
+`onz`    |
+`oov`    |
+`ooz`    |
+`ophv`   |
+`ophz`   |
+`opv`    |
+`opz`    |
+`osiv`   |
+`osiz`   |
+`osv`    |
+`osz`    |
+`pt`     |
+`qci`    |
+`rh`     |
+`ri`     |
+`rrr`    |
+`rs`     |
+`sa`     |
+`sbi`    |
+`si`     |
+`sid`    |
+`sim`    |
+`slp`    |
+`sme`    |
+`smf`    |
+`smv`    |
+`sst`    |
+`sx`     |
+`uh`     |
+`uid`    |
+`um`     |
+`vs`     |
+`vv`     |
+`w`      |
+`w1`     |
+`wbt`    |
+`wh`     |
+`wmi`    |
+`ww`     |
+`wwe`    |
+`wx`     |
+`yr`     |
\ No newline at end of file