sidfex.targettable.update: Update Position Information in SIDFEx Target Table

In helgegoessling/SIDFEx: Tools for the Sea Ice Drift Forecast Experiment (SIDFEx)

Update Position Information in SIDFEx Target Table

Description

Update position information in SIDFEx target table, using either a manual version or the file where recent position data is missing or an earlier version including (possibly outdated) position data.

Usage

sidfex.targettable.update(targettable.manual=NULL, targettable.out=NULL, download.obs=TRUE, data.path=NULL, download.obs.onlyactive=FALSE)

Arguments

targettable.manual	NULL or a character specifying the path and name of the text file for which an updated version shall be generated. Can be a manual version or the file where recent position data is missing or an earlier version including (possibly outdated) position data. If NULL (default), the manual version of the target table delivered with the SIDFEx package is used. In this case, make sure that you have the latest version of the SIDFEx package. Otherwise, the manual target table used as input might be outdated, that is, new targets and/or information on discarded targets might be missing.
targettable.out	NULL or a character specifying the path and name of the output text file. If NULL, no file will be written and only the updated data table will be returned by the function.
download.obs	a logical value specifying whether or not to download the latest versions of the observational data first. Default is TRUE. If FALSE, be aware that the local data used to extract the latest position data might be outdated.
data.path	NULL or a character specifying the local directory of the observational data. Usually, NULL (default) should be appropriate. For details, see the same argument in sidfex.download.obs.
download.obs.onlyactive	a logical value specifying whether or not to download (if download.obs=TRUE) only observations for targets that are still active . Default is FALSE.

Value

a data frame with the updated SIDFEx target table.

Note

If run with targettable.manual=NULL, make sure that you have the latest version of the SIDFEx package. Otherwise, the manual target table used as input might be outdated, that is, new targets and/or information on discarded targets might be missing.

Be aware that the data used to extract the latest position data might be outdated if you run this function with download.obs=FALSE.

Author(s)

Helge Goessling

Examples

targettable = sidfex.targettable.update(targettable.out="~/SIDFEX_targettable_autoupdate.txt", download.obs=FALSE)
# the argument 'download.obs' has been set 'FALSE' to make sure that the
# example works without internet conncetion; should usually be 'TRUE'.

helgegoessling/SIDFEx documentation built on March 15, 2024, 2:26 p.m.