summarise_popDemographics {rSHAPE}

This function will use output from summarise_experimentFiles and summarise_experimentParameters to help with expectations concerning run output and handling. This will save an RData file which will contain one object: all_popSets, which is a list of relevant control information about I/O and then a series of other RData files which contain the demographics information as a matrix with the mean and standard deviation of demographics for all replicates.

Description

This function will use output from summarise_experimentFiles and summarise_experimentParameters to help with expectations concerning run output and handling. This will save an RData file which will contain one object: all_popSets, which is a list of relevant control information about I/O and then a series of other RData files which contain the demographics information as a matrix with the mean and standard deviation of demographics for all replicates.

Usage

summarise_popDemographics(funcSave_jobExpression,
  func_saveFile = getOption("shape_procExp_filenames")["popDemographics"],
  func_experimentDir = getOption("shape_workDir"),
  func_saveDir = getOption("shape_postDir"),
  func_refFile = getOption("shape_procExp_filenames")[c("fileList",
  "parameters")], func_workEnvir = new.env(),
  func_objPrefix = "popDemo_")

Arguments

funcSave_jobExpression

This is a string expression that can be used to find elements of the experiment being analysed. It should be some robust unique string or regular expression.

func_saveFile

This is the filepath and filename (ending in .RData please) to which the results of this step will be saved.

func_experimentDir

This is the filepath to the root directoy under which all your experimental files can be found.

func_saveDir

This is the directory to which output will be saved.

func_refFile

This is the filepath to the reference file that contains information regarding all the processed files for the rSHAPE experiment.

func_workEnvir

This is an environment used to load files with the load function. It's used to encapsulate the loaded information to a controlled space.

func_objPrefix

This is a character string for programatic naming of objects of this type.

Note

There is no example as this cannot work without a complete rSHAPE experiment to be analysed.