From 6c0342a65341af4a60ed06a53c0f86317895aa48 Mon Sep 17 00:00:00 2001
From: aho <an.ho@bsc.es>
Date: Mon, 11 Dec 2023 15:23:08 +0100
Subject: [PATCH] Improve doc for use_libraries

---
 DESCRIPTION | 2 +-
 R/Step.R    | 4 +++-
 man/Step.Rd | 4 +++-
 3 files changed, 7 insertions(+), 3 deletions(-)

diff --git a/DESCRIPTION b/DESCRIPTION
index 60fa08c..90b03a7 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -42,5 +42,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.0
+RoxygenNote: 7.2.3
 Config/testthat/edition: 3
diff --git a/R/Step.R b/R/Step.R
index e5d7304..3c997f0 100644
--- a/R/Step.R
+++ b/R/Step.R
@@ -19,7 +19,9 @@
 #'  for multiple returned arrays indicating the dimension names of the function
 #'  output. 
 #'@param use_libraries A vector of character string indicating the R library 
-#'  names to be used in 'fun'. The default value is NULL.
+#'  names to be used in 'fun'. Only used when the jobs are run on HPCs; if the 
+#'  jobs are run locally, load the necessary libraries by \code{library()}
+#'  directly. The default value is NULL.
 #'@param use_attributes One or more lists of vectors of character string 
 #'  indicating the data attributes to be used in 'fun'. The list name should be
 #'  consistent with the list name of 'data' in AddStep(). The default value is 
diff --git a/man/Step.Rd b/man/Step.Rd
index c473ccb..283c555 100644
--- a/man/Step.Rd
+++ b/man/Step.Rd
@@ -28,7 +28,9 @@ for multiple returned arrays indicating the dimension names of the function
 output.}
 
 \item{use_libraries}{A vector of character string indicating the R library 
-names to be used in 'fun'. The default value is NULL.}
+names to be used in 'fun'. Only used when the jobs are run on HPCs; if the 
+jobs are run locally, load the necessary libraries by \code{library()}
+directly. The default value is NULL.}
 
 \item{use_attributes}{One or more lists of vectors of character string 
 indicating the data attributes to be used in 'fun'. The list name should be
-- 
GitLab