Read a base from a file. The file formats are described in the kstIO-package information page.

read_kbase(filename, format = "auto", as.letters = TRUE)

Arguments

filename

A character string specifying the name of the base file.

format

Specification of the files format. Can be "SRBT", "KST", "matrix", or "auto" (default).

as.letters

logical, should the elements of the sets be letters or numbers?

Details

The format values "SRBT", "KST", and "matrix" refer to the different generations of file formats described in kstIO-package. The value "auto" (default) requests an automatic detection of the format by thje read_XXX function.

If as.letters is TRUE the elements of the sets are letters, otherwise numbers.

Value

A list with the following elements:

matrix

the read structure/data as binary matrix

sets

the read structure as object of class kbase

References

Hockemeyer, C. (2001). KST Tools User Manual (2nd ed.). https://kst.hockemeyer.at/techreports/KST-Tools_TechRep_FWF01.pdf.

Poetzi, S. \& Wesiak, G. (2001). SRbT Tools User Manual. https://kst.hockemeyer.at/techreports/SRBT-Tools_TechRep_FWF01.pdf

Note

In automatic format detection, the distinction between "matrix" and "KST" formats work somewhat heuristic. In other words, in rare cases the automatic detection might give the wrong result.

Author

Cord Hockemeyer cord.hockemeyer@uni-graz.at

See also

Examples

# Produce a base file library(kst)
#> Loading required package: proxy
#> #> Attaching package: ‘proxy’
#> The following objects are masked from ‘package:stats’: #> #> as.dist, dist
#> The following object is masked from ‘package:base’: #> #> as.matrix
d <- getwd() setwd(tempdir()) data(DoignonFalmagne7) b <- kbase(kspace(kstructure(as.pattern(DoignonFalmagne7$K, as.set=TRUE)))) write_kbase(b, "DF7.bas", "KST") # (Old) KST format # Read file read_kbase("DF7.bas") # Automatic format detection
#> $matrix #> a b c d e #> [1,] 1 0 0 0 0 #> [2,] 0 1 0 0 0 #> [3,] 1 1 1 0 0 #> [4,] 1 1 0 1 0 #> [5,] 1 1 1 0 1 #> #> $sets #> {{"a"}, {"b"}, {"a", "b", "c"}, {"a", "b", "d"}, {"a", "b", "c", "e"}} #>
read_kbase("DF7.bas", "KST") # Explicit format specification
#> $matrix #> a b c d e #> [1,] 1 0 0 0 0 #> [2,] 0 1 0 0 0 #> [3,] 1 1 1 0 0 #> [4,] 1 1 0 1 0 #> [5,] 1 1 1 0 1 #> #> $sets #> {{"a"}, {"b"}, {"a", "b", "c"}, {"a", "b", "d"}, {"a", "b", "c", "e"}} #>
setwd(d)