AQSys.plot: Dataset and Fitted Function plot

View source: R/AQSys.R

AQSys.plotR Documentation

Dataset and Fitted Function plot

Description

The function returns a plot after fitting a dataset to the mathematical descriptor chosen by the user.

Usage

## S3 method for class 'plot'
AQSys(
  dataSET,
  xlbl = "",
  ylbl = "",
  main = NULL,
  col = "blue",
  type = "p",
  cex = 1,
  cexlab = 1,
  cexaxis = 1,
  cexmain = 1,
  cexsub = 1,
  modelName = "merchuk",
  NP = 100,
  xmax = "",
  ymax = "",
  Order = "xy",
  save = FALSE,
  HR = FALSE,
  filename = NULL,
  wdir = NULL,
  silent = FALSE,
  ...
)

Arguments

dataSET

- Binodal Experimental data that will be used in the nonlinear fit. It might hold multiple systems stacked side-by-side. [type:data.frame]

xlbl

Plot's Horizontal axis label.

ylbl

Plot's Vertical axis label.

main

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

col

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

type

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

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

modelName

- Character String specifying the nonlinear empirical equation to fit data. The default method uses Merchuk's equation. Other possibilities can be seen in AQSysList().

NP

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

xmax

Maximum value for the Horizontal axis' value

ymax

Maximum value for the Vertical axis' value

Order

Defines how the data is organized in the Worksheet. Use "xy" whether the first column corresponds to the lower phase fraction and "yx" whether the opposite.

save

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

HR

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

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]

silent

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

...

Additional optional arguments. None are used at present.

Details

This version uses the plot function and return a regular orthogonal plot.

Value

A plot containing the experimental data, the correspondent curve for the binodal in study and the curve's raw XY data.

Examples

#Populating variable dataSET with binodal data
dataSET <- peg4kslt[, 1:2]
# Plot dataSET using Merchuk's function
#
AQSys.plot(dataSET)
#

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