read.gdx: Read item from '.gdx' file as quitte data frame

View source: R/read.gdx.R

read.gdxR Documentation

Read item from .gdx file as quitte data frame

Description

read.gdx() is a wrapper function for either gdxrrw::rgdx() or gamstransfer::readGDX() that returns a quitte data frame.

Usage

read.gdx(
  gdxName,
  requestList.name,
  fields = "l",
  colNames = NULL,
  factors = deprecated(),
  squeeze = TRUE
)

Arguments

gdxName

Path to a .gdx file.

requestList.name

Name of the item to read.

fields

Fields to read from variables and equations. When using gdxrrw, any of l, m, lo, up, s. When using using gamstransfer, level, marginal, lower, upper, and scale are understood as well. all will return all fields. Ignored when reading sets or parameters.

colNames

String vector of column names to override dimension and field names.

factors

Deprecated. Do not use any more.

squeeze

If TRUE, squeeze out any zero or EPS stored in the GDX container. Ignored when using gamstransfer.

Details

read.gdx() will use gdxrrw::rgdx() if gdxrrw is installed and the option quitte_force_gamstransfer is not TRUE, otherwise it will use gamstransfer::readGDX().

Value

A quitte data frame.

Author(s)

Michaja Pehl


pik-piam/quitte documentation built on April 12, 2025, 5:49 p.m.