From 78fee19320cdf360db7ec1aed2fb07ee4c533951 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Xavier=20Escrib=C3=A0=20Montagut?=
 <xavier.escriba.montagut@gmail.com>
Date: Wed, 15 Mar 2023 10:31:40 +0100
Subject: [PATCH] docs: update

---
 R/methylation_array_convertDS.R    | 17 +++++++++++++----
 man/methylation_array_convertDS.Rd | 17 ++++++++++++-----
 2 files changed, 25 insertions(+), 9 deletions(-)

diff --git a/R/methylation_array_convertDS.R b/R/methylation_array_convertDS.R
index c105bf3..3f71484 100644
--- a/R/methylation_array_convertDS.R
+++ b/R/methylation_array_convertDS.R
@@ -1,11 +1,20 @@
-#' @title Convert methylation arrays
+#' @title Convert a Methylation ExpressionSet from EPIC to 450k Array
 #'
-#' @param eSet `ExpressionSet` to convert
-#' @param objective_array `character` Array to which conver (`"450k"` or `"epic"`)
+#' @description This function subsets a methylation ExpressionSet from an EPIC array (850k probes) to a 450k array or vice versa.
 #'
-#' @return `ExpressionSet` converted
+#' @param eSet A methylation ExpressionSet object containing either EPIC or 450k array data.
+#' @param objective_array A character string specifying the target array type. Can be either "450k" or "epic".
+#'
+#' @return An ExpressionSet object containing the subset of probes based on the target array type.
 #' @export
 #'
+#' @examples
+#' # Load example data as 'eSet'
+#' # Convert the eSet from EPIC array to 450k array
+#' eSet_450k <- methylation_array_convertDS(eSet, objective_array = "450k")
+#' # Convert the eSet from 450k array to EPIC array
+#' eSet_epic <- methylation_array_convertDS(eSet, objective_array = "epic")
+
 methylation_array_convertDS <- function(eSet, objective_array){
 
   if(objective_array == "450k"){
diff --git a/man/methylation_array_convertDS.Rd b/man/methylation_array_convertDS.Rd
index f864290..bbf02e3 100644
--- a/man/methylation_array_convertDS.Rd
+++ b/man/methylation_array_convertDS.Rd
@@ -2,18 +2,25 @@
 % Please edit documentation in R/methylation_array_convertDS.R
 \name{methylation_array_convertDS}
 \alias{methylation_array_convertDS}
-\title{Convert methylation arrays}
+\title{Convert a Methylation ExpressionSet from EPIC to 450k Array}
 \usage{
 methylation_array_convertDS(eSet, objective_array)
 }
 \arguments{
-\item{eSet}{`ExpressionSet` to convert}
+\item{eSet}{A methylation ExpressionSet object containing either EPIC or 450k array data.}
 
-\item{objective_array}{`character` Array to which conver (`"450k"` or `"epic"`)}
+\item{objective_array}{A character string specifying the target array type. Can be either "450k" or "epic".}
 }
 \value{
-`ExpressionSet` converted
+An ExpressionSet object containing the subset of probes based on the target array type.
 }
 \description{
-Convert methylation arrays
+This function subsets a methylation ExpressionSet from an EPIC array (850k probes) to a 450k array or vice versa.
+}
+\examples{
+# Load example data as 'eSet'
+# Convert the eSet from EPIC array to 450k array
+eSet_450k <- methylation_array_convertDS(eSet, objective_array = "450k")
+# Convert the eSet from 450k array to EPIC array
+eSet_epic <- methylation_array_convertDS(eSet, objective_array = "epic")
 }