Package 'LEEF.measurement.flowcam'

Title: Pre-Process and Extract Flowcam Data
Description: More about what it does (maybe more than one line) Use four spaces when indenting paragraphs within the Description.
Authors: Rainer M. Krug [aut, cre], SNF Project 310030_188431 [fnd]
Maintainer: Rainer M. Krug <[email protected]>
License: MIT + file LICENSE
Version: 0.8.31
Built: 2024-11-11 05:45:29 UTC
Source: https://github.com/LEEF-UZH/LEEF.measurement.flowcam

Help Index


Check if data in input folder is OK and move to raw data folder

Description

Check if data in input folder is OK and move to raw data folder

Usage

add_new_data(input, output)

Arguments

input

The folder, where a folder flowcam is located which contains the new files.

output

A folder, which contains a subfolder called flowcam, i.e. the usually the raw data folder, into which the fioles will be moved to.

Value

a list which contains the individual reseults for each file. TRUE if moved, FALSE if an error occured. Details of the eror re in the error files in the input/flowcam directory.


Classify algae_traits nad calculates densities

Description

Classify algae_traits nad calculates densities

Usage

classify(
  algae_traits,
  classifiers_constant,
  classifiers_increasing,
  composition,
  exp_design,
  species_tracked,
  timestamp
)

Arguments

algae_traits

algae_traits

classifiers_constant

constant temperature classifier

classifiers_increasing

increasing temperature classifier

composition

composition

exp_design

experimental design

species_tracked

species tracked

timestamp

timestamp to be used to stamp the classified data

Value

list containing two objects:

  • algae_traits including species

  • algae_densities densities of the differenc particles identifieds


Preprocessor flowcam data

Description

extract data from all *_classes_*_data.csv files

Usage

extractor_flowcam(input, output)

Arguments

input

directory from which to read the data

output

directory to which to write the data

Value

invisibly TRUE when completed successful


Preprocessor flowcam data

Description

extract data from all *_classes_*_data.csv files

Usage

extractor_flowcam_classify(input, output)

Arguments

input

directory from which to read the data

output

directory to which to write the data

Value

invisibly TRUE when completed successful


Preprocessor flowcam data

Description

extract data from all *_classes_*_data.csv files

Usage

extractor_flowcam_filter(input, output)

Arguments

input

directory from which to read the data

output

directory to which to write the data

Value

invisibly TRUE when completed successful


Preprocessor flowcam data

Description

extract data from all *_classes_*_data.csv files

Usage

extractor_flowcam_prepare(input, output)

Arguments

input

directory from which to read the data

output

directory to which to write the data

Value

invisibly TRUE when completed successful


Load parameter from file

Description

Load parameter from file

Usage

load_parameter(file = "parameter.yaml")

Arguments

file

name of parameter file

Value

invisibly TRUE


Name of classifier file for constant temperature treatment

Description

Name of classifier file for constant temperature treatment

Usage

par_classifier_constant(value)

Name of classifier file for increasing temperature treatment

Description

Name of classifier file for increasing temperature treatment

Usage

par_classifier_increasing(value)

Species tracked

Description

Species tracked

Usage

par_species_tracked(value)

Template function to assign value to parameter in the package wide cache

Description

assign the function to a new cvariable and the name of the function woll be used for the parameter name. e.g:

  • fps <- par_template

Usage

par_template(value)

Arguments

value

if missing, the value of the parameter will be returned, NULL if the parameter does not exist; if specified, the parameter will be set to the value

Value

the (new) value of the argument


Preprocessor flowcam data

Description

Convert all .tif files in flowcam folder to zip compressed TIFF.

Usage

pre_processor_flowcam(input, output)

Arguments

input

directory from which to read the data

output

directory to which to write the data

Value

invisibly TRUE when completed successful


Check if data in raw data folder is OK

Description

Check if data in raw data folder is OK

Usage

raw_data_ok(input)

Arguments

input

raw data folder containing flowcam data, i.e usually is some/path/flowcam

Value

TRUE if ok, FALSE or list of problems if not

Examples

## Not run: 
raw_data_ok()

## End(Not run)

Register the processing of flowcam data in the LEEF package

Description

Register the processing of flowcam data in the LEEF package

Usage

register()

Value

invisibly TRUE when completed successful


Save parameter into .yaml file

Description

Save parameter into .yaml file

Usage

save_parameter(file = "parameter.yaml")

Arguments

file

name of parameter file

Value

invisibly TRUE