report_parameters: Generate Parameter Report for mass_dataset Object

In tidymass/massdataset: massdataset

Generate Parameter Report for mass_dataset Object

Description

This function generates an HTML report summarizing the parameters used in the processing of a mass_dataset object. The report is saved in a specified directory.

Usage

report_parameters(object, path = ".")

Arguments

object	A mass_dataset object for which the parameter report is to be generated.
path	The directory where the parameter report will be saved. Default is the current working directory.

Value

An HTML report summarizing the parameters used in the processing of the mass_dataset object. The report is saved in the specified directory.

Author(s)

Xiaotao Shen [e-mail]

Examples

## Not run: 
data("expression_data")
data("sample_info")
data("variable_info")
object =
  create_mass_dataset(
    expression_data = expression_data,
    sample_info = sample_info,
    variable_info = variable_info
  )
object

library(tidyverse)

object =
object %>%
  activate_mass_dataset(what = "expression_data") %>%
  filter(!is.na(QC_1))

object =
  object %>%
  activate_mass_dataset(what = "expression_data") %>%
  filter(!is.na(QC_2))

object =
object %>%
  mutate_mean_intensity()

object =
  object %>%
  mutate_median_intensity() %>%
  mutate_rsd()

report_parameters(object = object, path = "demo_data")

## End(Not run)

tidymass/massdataset documentation built on Jan. 30, 2024, 2:55 p.m.