From 859e9a760b3c455d3436517e6f324ce805887ba3 Mon Sep 17 00:00:00 2001
From: Johanna Fleischman <71276903+johanna0321@users.noreply.github.com>
Date: Thu, 16 May 2024 14:44:03 -0700
Subject: [PATCH] Update function documentation

---
 R/mutate_mzroll_list.R       | 16 ++++++++--------
 man/fill_in_missing_peaks.Rd |  8 ++++----
 man/impute_missing_peaks.Rd  |  8 ++++----
 3 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/R/mutate_mzroll_list.R b/R/mutate_mzroll_list.R
index 4a57223..b4224ca 100644
--- a/R/mutate_mzroll_list.R
+++ b/R/mutate_mzroll_list.R
@@ -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
 #'
@@ -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
 #'
diff --git a/man/fill_in_missing_peaks.Rd b/man/fill_in_missing_peaks.Rd
index 8c1e1ce..ee4dae7 100644
--- a/man/fill_in_missing_peaks.Rd
+++ b/man/fill_in_missing_peaks.Rd
@@ -12,13 +12,13 @@ fill_in_missing_peaks(
 )
 }
 \arguments{
-\item{mzroll_list:}{data in triple omic structure}
+\item{mzroll_list}{data in triple omic structure}
 
-\item{fill_values:}{either a numeric constant or a tibble that maps groupId to log2 feature-level imputation values}
+\item{fill_values}{either a numeric constant or a tibble that maps groupId to log2 feature-level imputation values}
 
-\item{quant_var:}{column to use for peak values}
+\item{quant_var}{column to use for peak values}
 
-\item{imputation_sd:}{standard deviation of Gaussian distribution to use for missing peak imputation}
+\item{imputation_sd}{standard deviation of Gaussian distribution to use for missing peak imputation}
 }
 \value{
 triple omic data with imputed missing peaks
diff --git a/man/impute_missing_peaks.Rd b/man/impute_missing_peaks.Rd
index a735c6b..74d6cac 100644
--- a/man/impute_missing_peaks.Rd
+++ b/man/impute_missing_peaks.Rd
@@ -12,13 +12,13 @@ impute_missing_peaks(
 )
 }
 \arguments{
-\item{mzroll_list:}{data in triple omic structure}
+\item{mzroll_list}{data in triple omic structure}
 
-\item{lod_values:}{a tibble that maps groupId to log2 feature-level imputation values}
+\item{lod_values}{a tibble that maps groupId to log2 feature-level imputation values}
 
-\item{quant_var:}{column to use for peak values}
+\item{quant_var}{column to use for peak values}
 
-\item{imputation_sd:}{standard deviation of Gaussian distribution to use for missing peak imputation}
+\item{imputation_sd}{standard deviation of Gaussian distribution to use for missing peak imputation}
 }
 \value{
 triple omic data with imputed missing peaks