API Reference

This is an old version of this page. You can view the most recent version or browse the history.

Note: still not complete! probably tomorrow

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.
`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)
`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. 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.
`clean_data.R`	---.
`clean2track.R`	Forms ship tracks for linked `ID`s. --.

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`

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`