gdsfmt (version 1.8.3)

objdesp.gdsn: Variable description

Description

Get the description of a GDS node.

Usage

objdesp.gdsn(node)

Arguments

node

an object of class gdsn.class, a GDS node

Value

Returns a list:

name

the variable name of a specified node

fullname

the full name of a specified node

storage

the storage mode in the GDS file

trait

the description of data field, like "Int8"

type

a factor indicating the storage mode in R: Label -- a label node, Folder -- a directory, VFolder -- a virtual folder linking to another GDS file, Raw -- raw data (addfile.gdsn), Integer -- integers, Factor -- factor values, Logical -- logical values (FALSE, TRUE and NA), Real -- floating numbers, String -- characters, Unknown -- unknown type

is.array

indicates whether it is array-type

dim

the dimension of data field

encoder

encoder for compressed data, such like "ZIP"

compress

the compression method: "", "ZIP.max", etc

cpratio

data compression ratio, NaN indicates no compression

size

the size of data stored in the GDS file

good

logical, indicates the state of GDS file, e.g., FALSE if the virtual folder fails to link the target GDS file

hidden

logical, TRUE if it is a hidden object

message

if applicable, messages of the GDS node, such like error messages, log information

param

the parameters, used in add.gdsn, like "maxlen", "offset", "scale"

References

http://github.com/zhengxwen/gdsfmt

See Also

cnt.gdsn, name.gdsn, ls.gdsn, index.gdsn

Examples

# cteate a GDS file
f <- createfn.gds("test.gds")

# add a vector to "test.gds"
node1 <- add.gdsn(f, name="vector1", val=1:10000)
objdesp.gdsn(node1)

# add a vector to "test.gds"
node2 <- add.gdsn(f, name="vector2", val=1:10000, compress="ZIP.max",
    closezip=FALSE)
objdesp.gdsn(node2)

# add a character to "test.gds"
node3 <- add.gdsn(f, name="vector3", val=c("A", "BC", "DEF"),
    compress="ZIP", closezip=TRUE)
objdesp.gdsn(node3)

# close the GDS file
closefn.gds(f)


# delete the temporary file
unlink("test.gds", force=TRUE)