aiR: aiR

Description Usage Arguments Value

View source: R/main.R

Description

aiR

Usage

1
2
3
aiR(data, input.col, var.classify, aiRnet, cycles = 100,
  sample.method = "Sample", sample.size = 0.5, batch.size = "all",
  sample.Factor = NULL, na.rm = TRUE, test.rate = "fast")

Arguments

data

Data frame that contains all named columns needed

input.col

character vector of column names for aiRnet

var.classify

index or column name of vector that contains classifying values

aiRnet

aiRnet object generated by aiRnet function

cycles

Number of cycles done to correct.

sample.method

Method to save internal subset of data as the training data. "Sample" to take a random sample of all rows in data as training set. "Factor" to indicate if you are training on rows containing a particular factor level.

sample.size

Number between (0-1) that modifies how much of desired sample.method data is used. Default set to 0.5. Excluded rows will be used as test examples and not affect aiRnet.

batch.size

Number indicating how many rows to make batches from training sample. Default set to "all" for no batches to be made.

sample.Factor

Necessary when sample.method set to "Factor". Assign as vector of length 2 in the following form c("column.index/name","factor.level"). Can assign only column name or index but first level is chosen in this case.

na.rm

remove NAs, default set to TRUE. Function likely to fail with NAs

test.rate

"none" or "fast" or "slow" or integer specifying how often the test model is checked. Test model is used only when sample.size < 0.8 is set, otherwise the full model is used instead. "fast" indicates model is tested at begining and end. "slow" indicates full model is tested each cycle. An integer indicates how many cycles pass before testing the model. e.i. 1 is equivelent to "slow", 2 is every other cycle, 3 is every third cycle, ... etc. "none" indicates that the model will not be verified on any model.

Value

data frame of loss and the aiRnet of the training values. data set used is optional


jtlandis/aiR documentation built on Dec. 26, 2019, 3:35 a.m.