API-Reference.md

 This page lists all available functions and classes in the 
 ICOADS R HOSTACE toolbox.
 
+**Workflow**
+
+Script | Description 
+-------- |:------------
+`split_by_type.R` | Separates records according to the different platform types. This is done following a [selection criteria](Workflow/data-selection).  
+`simple_dup.R`   | Duplicate record identification among ship data and the rest of the different platform types for which the records show a matching `date` , `time` and position `(lat, lon)`.
+`ship2plat.R`   | Excludes non-ship data. Uses additional information from WMO Publication 47 to flag non-ship data. [Kent. *et al.,* (2007)](https://doi.org/10.1175/JTECH1949.1)
+`process_ids.R`   |  Re-format of ship IDs that comes from different data sources (`SID`) to enable linking of data from the same ship (same ship name) across different `DCK`s. And to also enable linking to metadata information in WMO Publication No. 47.
+`process_shipdata.R`   | Corrects dates and times errors noticed in some `DCK`. Largely arise from confusion over historical definitions of the marine day and conversions between local time and UTC.
+`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**
+
+
+**Utils**
+
+Function | Description 
+-------- |:------------
+`add_date2.R ` |   
+`add_dck_priority.R `   | 
+`add_ID_class.R `   | 
+`add_shipnames.R`   | 
+`assess_match.R`   | 
+`find_gap_func.R`   | 
+`fix_usmm_705to707cors_func.R`   | 
+`flag_id_dups.R`   | 
+`get_gap_pos.R`   | 
+`get_groups.R`   | 
+`get_id_class.R`   | 
+`get_isolated.R`   | 
+`get_itu_country.R`   | 
+`get_matchedids.R`   | 
+`get_mismatch.R`   | 
+`get_prec.R`   | 
+`get_speed.R`   | 
+`id_group_func.R`   | 
+`liz_merge.R`   | 
+`new_add_match_id.R`   | 
+`new_homog_ids.R`   | 
+`print_id_match_info.R`   | 
+`read_rdsfiles.R`   | 
+`write_dup_func.R`  |