checkIndex: check indexes

Description Usage Arguments Value Author(s) See Also Examples

View source: R/checkIndex.R

Description

check indexes. Mainly for internal usage in createIndex(). Not exported, so call it as rdwd:::checkIndex() if you want to run tests yourself. Further test suggestions are welcome!

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
checkIndex(
  findex = NULL,
  mindex = NULL,
  gindex = NULL,
  excludefp = TRUE,
  fast = FALSE,
  warn = !quiet,
  logfile = localtestdir(".", "misc/ExampleTests/warnings.txt"),
  quiet = rdwdquiet()
)

Arguments

findex

fileIndex. DEFAULT: NULL

mindex

metaIndex. DEFAULT: NULL

gindex

geoIndex. DEFAULT: NULL

excludefp

Exclude false positives from geoIndex coordinate check results? DEFAULT: TRUE

fast

Exclude the 3-minute location per ID check? DEFAULT: FALSE

warn

Warn about issues? DEFAULT: !quiet (TRUE)

logfile

File to copy log to, appended to existing content. NULL to suppress. DEFAULT: "misc/ExampleTests/warnings.txt"

quiet

Logical: Suppress progress messages? DEFAULT: FALSE through rdwdquiet()

Value

Charstring with issues (if any) to be printed with cat().

Author(s)

Berry Boessenkool, berry-b@gmx.de, May 2019

See Also

createIndex

Examples

1
2
3
data(fileIndex) ; data(metaIndex) ; data(geoIndex)
# ci <- rdwd:::checkIndex(findex=fileIndex, mindex=metaIndex, gindex=geoIndex)
# cat(ci)

rdwd documentation built on April 9, 2021, 1:06 a.m.