AQSysCurve: This functions plot a curve based in the chosen model and its...

View source: R/AQSysCurve.R

AQSysCurveR Documentation

This functions plot a curve based in the chosen model and its parameters.

Description

The function returns a plot after using the parameters and model given by the user.

Usage

AQSysCurve(
  modelName,
  modelPars,
  seriesNames = NULL,
  xlbl = "",
  ylbl = "",
  col = "black",
  type = "p",
  cex = 1,
  cexlab = 1,
  cexaxis = 1,
  cexmain = 1,
  cexsub = 1,
  xmax = 35,
  HR = FALSE,
  NP = 100,
  filename = NULL,
  wdir = NULL,
  save = FALSE,
  silent = FALSE,
  ...
)

Arguments

modelName

Equation to be used: merchuk, murugesan [type:string]

modelPars

Model's parameters [type::data.frame]

seriesNames

A list of sequential names which will identify each system provided by the user in the dataSET variable. [type:List]

xlbl

Plot's Horizontal axis label.

ylbl

Plot's Vertical axis label.

col

Legacy from plot package. For more details, see plot.default

type

1-character string giving the type of plot desired. The following values are possible, for details, see plot: "p" for points, "l" for lines, "b" for both points and lines, "c" for empty points joined by lines, "o" for overplotted points and lines, "s" and "S" for stair steps and "h" for histogram-like vertical lines. Finally, "n" does not produce any points or lines.

cex

Legacy from plot package. For more details, see plot.default

cexlab

Legacy from plot package. For more details, see plot.default

cexaxis

Legacy from plot package. For more details, see plot.default

cexmain

Legacy from plot package. For more details, see plot.default

cexsub

Legacy from plot package. For more details, see plot.default

xmax

Maximum value for the Horizontal axis' value (bottom-rich component) [type:double]

HR

Adjust Plot's text to be compatible with High Resolution size [type:Logical]

NP

Number of points used to build the fitted curve. Default is 100. [type:Integer]

filename

Filename provided by the user to save a given plot. [type:String]

wdir

The directory in which the plot file will be saved. [type:String]

save

Save the generated plot in the disk using path and filename provided by the user. [type:Logical]

silent

save plot file without actually showing it to the user. [type:Logical]

...

other graphical parameters (see par and section ‘Details’ below).

Details

The function owns predefined set of equations that can be seen below and must be used, with adequated parameters, to return a plot which represent the chosen model.

Value

A plot using the input model within the chosen interval and the curve's raw XY data. If no interval is selected, xmax = 0.4.

Examples

## Not run: 
AQSysCurve("murugesan", data.frame(90.389, -34.897, 2.924), col = "red")

## End(Not run)

Hutchr/LLSR documentation built on May 31, 2022, 11:56 p.m.