OutputParams: Create OutputParams object

Description Usage Arguments Value Examples

View source: R/params.R

Description

Create OutputParams object

Usage

1
2
3
4
5
6
7
8
OutputParams(
  outputFilename = "simulationOutput.out",
  outputNumInitialDistance = 10,
  outputNumPairwiseDistance = 10,
  outputNumFamilyLabels = 10,
  outputNumFamilyMatrix = 10,
  outputMinSimilarity = 0.5
)

Arguments

outputFilename

Where should the results of the simulation be saved? (This can be parsed by input_file)

outputNumInitialDistance

How many times across the simulation will we output the distance of each sequence to the initial sequence

outputNumPairwiseDistance

How many times across the simulation will we output the pairwise distance between all pairs of sequences

outputNumFamilyLabels

How many times across the simulation will we output the representative sequences for each family?

outputNumFamilyMatrix

How many times across the simulation will we output the pairwise distances between family representatives?

outputMinSimilarity

What is the minimum similarity between two sequences we should report on?

Value

A bundling of the parameters given to it as a SimulationParams object

Examples

1
outputParams <- OutputParams(outputFilename = 'myOutputFilename.out')

retrocombinator documentation built on Nov. 12, 2021, 1:07 a.m.