Disclaimer

This document contains a short How-To for using this package to simulate composite milk record data.

Introduction

Composite milk record data are simulated using the R6 class R6ClassCompositeMilkRecord. Objects of R6ClassCompositeMilkRecord consist of the following components.

Simulate a composite milk record

A composite milk record can be simulated using the method sampleUnifRecord() of R6ClassCompositeMilkRecord. When creating an instance of R6ClassCompositeMilkRecord all the components are initialized. The method sampleUnifRecord() generates values for each of the components. The result of simulating one composite milk record can be shown as follows.

### # set seed for reproducibillity
set.seed(1234)
### # instatiate a composite milk object
r6objComMilkRec <- ImsDataTransferSimulation::R6ClassCompositeMilkRecord$new()
### # simulate
r6objComMilkRec$sampleUnifRecord()
### # show the result
cat("Simulation result:\n", r6objComMilkRec$toTsvString(), "\n", sep = "")

The above shown record can also be written to a file using method writeTsvStringToFile().

r6objComMilkRec$writeTsvStringToFile()
r6objComMilkRec$writeCsv2StringToFile()

In order to upload some files, we generate new instances.

r6objComMilkRecNew <- ImsDataTransferSimulation::R6ClassCompositeMilkRecord$new()
r6objComMilkRecNew$sampleUnifRecord()
r6objComMilkRecNew$writeTsvStringToFile(psFileName = "new_record.tsv")
r6objComMilkRecNew$writeCsv2StringToFile(psFileName = "new_record.csv")

r6objComMilkRec2 <- ImsDataTransferSimulation::R6ClassCompositeMilkRecord$new()
r6objComMilkRec2$sampleUnifRecord()
r6objComMilkRec2$writeTsvStringToFile(psFileName = "new_record2.tsv")
r6objComMilkRec2$writeCsv2StringToFile(psFileName = "new_record2.csv")

r6objComMilkRec3 <- ImsDataTransferSimulation::R6ClassCompositeMilkRecord$new()
r6objComMilkRec3$sampleUnifRecord()
r6objComMilkRec3$writeTsvStringToFile(psFileName = "o_new_record3.tsv")
r6objComMilkRec3$writeCsv2StringToFile(psFileName = "o_new_record3.csv")

Put more records in a file.

nNrRecord <- 5
for(i in 1:nNrRecord){
  r6objLoop <- ImsDataTransferSimulation::R6ClassCompositeMilkRecord$new()
  r6objLoop$sampleUnifRecord()
  r6objLoop$writeTsvStringToFile(psFileName = "multiple_records.tsv",
                                 pbAppend   = TRUE)
}


pvrqualitasag/ImsDataTransferSimulation documentation built on May 26, 2019, 11:34 a.m.