sidfex.fcst.search.createIndexTable: DEPRECATED - Create search index table for whole forecast...

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

DEPRECATED - Create search index table for whole forecast directory

Description

DEPRECATED (replaced by sidfex.fcst.search.createIndex) - Loop through the downloaded SIDFEx forecasts and add some predefined key quantities and information to the (previously existing or not) index file "indexTable.rda". If the specified index file does not exist, a new one is created. The data will be stored in .rda-format.

Usage

  sidfex.fcst.search.createIndexTable (indexTable.path = NULL, data.path = NULL, do.fromScratch = FALSE, do.saveAddCSV = TRUE, checkfileformat = TRUE, do.print.less = TRUE)

Arguments

indexTable.path	NULL or a character specifying the directory where to find or create the index file. If NULL, it is attempted to source a file named .SIDFEx in the home directory where a character variable data.path.indexTable.in needs to be defined.
data.path	NULL or a character specifying the directory where to find the forecast data locally. If NULL, it is attempted to source a file named .SIDFEx in the home directory where a character variable data.path.fcst needs to be defined.
do.fromScratch	a boolen value, default FALSE. If set to FALSE, an existing index file will be extended by all files that have not been added before. If set to TRUE, the existing index file will be removed and a new one is created from scratch.
do.saveAddCSV	a boolean value, default TRUE. If so, a CSV version of the data frame will be stored in addition to the .rda-file in the same directory.
checkfileformat	a logical value specifying whether or not to check if the file format complies with the SIDFEx conventions, using sidfex.checkfileformat.
do.print.less	a logical value specifying whether or not to print a statement for every dataset while adding it to the index file (to keep console output down). Will be also passed on to sidfex.fcst.search.addTableItem.

Value

This function returns 1 if it ran successfully.

Note

Use the option do.fromScratch carefully, as (for now) the existing file is removed before the new one is created. If there's some time for that task in the future, a backup copy of the old file will be stored until the new one is written on disk - implementation pending.

The optionally produced CSV file is mainly generated for users not familiar with R. As it is only a copy of the .rda file and won't be altered or affected by changes in the .rda file in general, it is recommended to work with the .rda file whenever possible.

Author(s)

Simon Reifenberg

See Also

sidfex.fcst.search.addTableItem, sidfex.fcst.search.extractFromTable, sidfex.fcst.search.rda2csv

helgegoessling/SIDFEx documentation built on June 15, 2024, 12:14 a.m.