eempf_openfluor: Write out PARAFAC components to submit to openfluor.org.

In staRdom: PARAFAC Analysis of EEMs from DOM

Write out PARAFAC components to submit to openfluor.org.

Description

openfluor.org offers the possibility to compare your results to others, that were uploaded to the database. This functions writes out a txt containing the header lines and your components. Please open the file in an editor and fill in further information that cannot be covered by this function.

Usage

eempf_openfluor(
  pfmodel,
  file,
  Fmax = TRUE,
  upload = FALSE,
  email = NULL,
  model_details = list()
)

Arguments

pfmodel	PARAFAC model
file	string, path to outputfile. The directory must exist, the file will be created or overwritten if already present.
Fmax	rescale modes so the A mode shows the maximum fluorescence. As openfluor does not accept values above 1, this is a way of scaling the B and C modes to a range between 0 and 1.
upload	logical, whether model is directly uploaded to openfluor.org
email	optional email address to log into openfluor.org
model_details	optional named list with strings to be added in the openfluor file in the fields corresponding to the list names

Value

txt file

Examples

  data(pf_models)

  model_details <- list(name = "River", creator = "Helena Glory",
  constraints = "non-negative", validation = "split-half", unit= "RU")
  eempf_openfluor(pf4[[1]],file.path(tempdir(),"openfluor_example.txt"),
  upload = FALSE, model_details = model_details)

staRdom documentation built on July 9, 2023, 5:57 p.m.