From eeb7cd4cc975033a06c0b1c44f2777467a4901ba Mon Sep 17 00:00:00 2001
From: vagudets <victoria.agudetse@bsc.es>
Date: Mon, 19 Feb 2024 09:57:48 +0100
Subject: [PATCH] Add 'ExpectedFiles' and 'PatternDim' to Start() output
 documentation

---
 DESCRIPTION  | 2 +-
 R/Start.R    | 8 +++++++-
 man/Start.Rd | 8 +++++++-
 3 files changed, 15 insertions(+), 3 deletions(-)

diff --git a/DESCRIPTION b/DESCRIPTION
index 8fd5ee1..88bfb62 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -44,5 +44,5 @@ URL: https://earth.bsc.es/gitlab/es/startR/
 BugReports: https://earth.bsc.es/gitlab/es/startR/-/issues
 SystemRequirements: cdo ecFlow
 Encoding: UTF-8
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1
 Config/testthat/edition: 3
diff --git a/R/Start.R b/R/Start.R
index 5bfb3bf..2be297b 100644
--- a/R/Start.R
+++ b/R/Start.R
@@ -750,6 +750,9 @@
 #'  components used to build up the paths to each of the files in the data
 #'  sources.
 #'  }
+#'  \item{PatternDim}{
+#'  Character string containing the name of the file pattern dimension.
+#'  }
 #'If \code{retrieve = FALSE} the involved data is not loaded into RAM memory and
 #'an object of the class 'startR_header' with the following components is
 #' returned:\cr
@@ -766,7 +769,7 @@
 #'  multidimensional array with named dimensions, and potentially with the
 #'  attribute 'variables' with additional auxiliary data.
 #'  }
-#'  \item{Files}{
+#'  \item{ExpectedFiles}{
 #'  Multidimensonal character string array with named dimensions. Its dimensions
 #'  are the file dimensions (as requested in \dots). Each cell in this array
 #'  contains a path to a file to be retrieved (which may exist or not).
@@ -777,6 +780,9 @@
 #'  components used to build up the paths to each of the files in the data
 #'  sources.
 #'  }
+#'  \item{PatternDim}{
+#'  Character string containing the name of the file pattern dimension.
+#'  }
 #'  \item{StartRCall}{
 #'  List of parameters sent to the Start() call, with the parameter
 #'  'retrieve' set to TRUE. Intended for calling in order to
diff --git a/man/Start.Rd b/man/Start.Rd
index 640c5a9..275ae9b 100644
--- a/man/Start.Rd
+++ b/man/Start.Rd
@@ -734,6 +734,9 @@ If \code{retrieve = TRUE} the involved data is loaded into RAM memory
  components used to build up the paths to each of the files in the data
  sources.
  }
+ \item{PatternDim}{
+ Character string containing the name of the file pattern dimension.
+ }
 If \code{retrieve = FALSE} the involved data is not loaded into RAM memory and
 an object of the class 'startR_header' with the following components is
 returned:\cr
@@ -750,7 +753,7 @@ returned:\cr
  multidimensional array with named dimensions, and potentially with the
  attribute 'variables' with additional auxiliary data.
  }
- \item{Files}{
+ \item{ExpectedFiles}{
  Multidimensonal character string array with named dimensions. Its dimensions
  are the file dimensions (as requested in \dots). Each cell in this array
  contains a path to a file to be retrieved (which may exist or not).
@@ -761,6 +764,9 @@ returned:\cr
  components used to build up the paths to each of the files in the data
  sources.
  }
+ \item{PatternDim}{
+ Character string containing the name of the file pattern dimension.
+ }
  \item{StartRCall}{
  List of parameters sent to the Start() call, with the parameter
  'retrieve' set to TRUE. Intended for calling in order to
-- 
GitLab