read.ecdb: Read API for the ecdb

read.ecdbR Documentation

Read API for the ecdb

Description

Read ecdb into data.frame. This can be accomplished by either specifying the range of alpha,gamma or the cartesian product of alpha,gamma point by point, or both. If both are specified, it follows a similar logic as plot how x,y is scoped by xlim,ylim.

Usage

## S3 method for class 'ecdb'
read(
  object,
  alpha = NULL,
  gamma = NULL,
  alim = NULL,
  glim = NULL,
  cusp = 0,
  polar_ext = FALSE
)

read(
  object,
  alpha = NULL,
  gamma = NULL,
  alim = NULL,
  glim = NULL,
  cusp = 0,
  polar_ext = FALSE
)

## S4 method for signature 'ecdb'
read(
  object,
  alpha = NULL,
  gamma = NULL,
  alim = NULL,
  glim = NULL,
  cusp = 0,
  polar_ext = FALSE
)

Arguments

object

an object of ecdb class

alpha, gamma

numeric vectors of points for cartesian product

alim, glim

length-two numeric vectors of min and max range

cusp

numeric. Type of cusp. Only 0 and 1 are allowed. If cusp=1, read cusp data on the critical line. Reading cusp data must be done from the alpha side. Default: 0.

polar_ext

logical, for polar coordinate extension: R, theta, angle. Default: FALSE.

Value

The data.frame from ECDATTR table.


ecd documentation built on May 10, 2022, 1:07 a.m.