generateClasses: Find the fishPi class from the excel definition file.

Description Usage Arguments Value Author(s) Examples

Description

Find the fishPi class from the excel definition file.

Usage

1
2
3
generateClasses(defFilePath, className, classVersion, additionalSlots = NULL,
  additionalSlotsPrototype = NULL, outputFilePath, eval = FALSE,
  xlsLibrary = "readxl")

Arguments

defFilePath

path of the excel definition.

className

name of the resulting class, better to set to "fishPi".

classVersion

version code of the generate class, something like "2.1", ...

additionalSlots

additional slots to include not present on the definion excel file. Sea example bellow.

additionalSlotsPrototype

prototype for additional slots.

outputFilePath

path of the generated class definition file.

eval

should the class definition to be evaluated at the end of the generation.

xlsLibrary

R XLS library to use, could be readxl (default) or xlsx.

Value

file path of the generated file.

Author(s)

Laurent Dubroca & Norbert Billet

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
## Not run: 
setwd("/home/norbert/Boulot/DCF/Projets/RDB-SC/")
source("generate_classes.R")
generateClasses(defFilePath="CS - Exchange format - 2.1.xlsx", 
                className="csPi", 
                classVersion="2.1", 
                additionalSlots=list(desc="character", popData="character", design="character",history="character"), 
                additionalSlotsPrototype=list(desc="Commercial Sampling Data format for the fishPi project", popData="Named population data object", design="Design description",history="modification history"), 
                outputFilePath="csPi_class.R",
                xlsLibrary="readxl",
                eval=TRUE)

testCsPi <- new(Class="csPi")
testCsPi

## End(Not run)

ldbk/fishPifct documentation built on May 20, 2019, 11:28 p.m.