Skip to content

Commit

Permalink
Update function documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
johanna0321 committed May 16, 2024
1 parent 5ef645e commit 859e9a7
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 16 deletions.
16 changes: 8 additions & 8 deletions R/mutate_mzroll_list.R
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,10 @@ floor_peaks <- function(mzroll_list,

#' Impute missing peaks with provided feature-level imputation values
#'
#'@param mzroll_list: data in triple omic structure
#'@param lod_values: a tibble that maps groupId to log2 feature-level imputation values
#'@param quant_var: column to use for peak values
#'@param imputation_sd: standard deviation of Gaussian distribution to use for missing peak imputation
#'@param mzroll_list data in triple omic structure
#'@param lod_values a tibble that maps groupId to log2 feature-level imputation values
#'@param quant_var column to use for peak values
#'@param imputation_sd standard deviation of Gaussian distribution to use for missing peak imputation
#'
#'@return triple omic data with imputed missing peaks
#'
Expand Down Expand Up @@ -138,10 +138,10 @@ impute_missing_peaks <- function(mzroll_list,
#'If \code{fill_values} is a data frame, this function calls \code{impute_missing_peaks()}.
#'If it is a numeric vector, 'this function calls \code{floor_peaks()}. Other types are not currently supported
#'
#'@param mzroll_list: data in triple omic structure
#'@param fill_values: either a numeric constant or a tibble that maps groupId to log2 feature-level imputation values
#'@param quant_var: column to use for peak values
#'@param imputation_sd: standard deviation of Gaussian distribution to use for missing peak imputation
#'@param mzroll_list data in triple omic structure
#'@param fill_values either a numeric constant or a tibble that maps groupId to log2 feature-level imputation values
#'@param quant_var column to use for peak values
#'@param imputation_sd standard deviation of Gaussian distribution to use for missing peak imputation
#'
#'@return triple omic data with imputed missing peaks
#'
Expand Down
8 changes: 4 additions & 4 deletions man/fill_in_missing_peaks.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions man/impute_missing_peaks.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 859e9a7

Please sign in to comment.