From 8aa206b061a72e4761875e4ca0bdfe3e9ba5d150 Mon Sep 17 00:00:00 2001
From: Thomas Wutzler <twutz@bgc-jena.mpg.de>
Date: Thu, 25 Jan 2024 15:30:34 +0100
Subject: [PATCH] add docu of sPlotDiurnalCycleM

---
 NAMESPACE                           |  1 +
 R/EddyPlotting.R                    | 18 ++++++-------
 R/aEddy.R                           |  1 +
 man/sEddyProc_sPlotDiurnalCycleM.Rd | 39 +++++++++++++++++++++++++++++
 4 files changed, 50 insertions(+), 9 deletions(-)
 create mode 100644 man/sEddyProc_sPlotDiurnalCycleM.Rd

diff --git a/NAMESPACE b/NAMESPACE
index 0ea1104..cf48cce 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -101,6 +101,7 @@ export(sEddyProc_sMRFluxPartitionUStarScens)
 export(sEddyProc_sPlotDailySums)
 export(sEddyProc_sPlotDailySumsY)
 export(sEddyProc_sPlotDiurnalCycle)
+export(sEddyProc_sPlotDiurnalCycleM)
 export(sEddyProc_sPlotFingerprint)
 export(sEddyProc_sPlotFingerprintY)
 export(sEddyProc_sPlotHHFluxes)
diff --git a/R/EddyPlotting.R b/R/EddyPlotting.R
index 6d668be..1f3b566 100644
--- a/R/EddyPlotting.R
+++ b/R/EddyPlotting.R
@@ -318,18 +318,18 @@ sEddyProc$methods(sPlotFingerprint = sEddyProc_sPlotFingerprint)
 #+++ Diurnal cycles
 #+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-# #' @export
-.sEddyProc_sPlotDiurnalCycleM <- function(
+#' @export
+sEddyProc_sPlotDiurnalCycleM <- function(
   ### The diurnal cycles of a single month are plotted to the current device,
   ### scaled to all data. Each year is plotted as a different (coloured) line.
   Var = Var.s               ##<< Variable to plot
-  , QFVar = if (!missing(QFVar.s)) QFVar.s else 'none'     ##<<
-  ## Quality flag of variable to be filled
-  , QFValue = if (!missing(QFValue.n)) QFValue.n else NA_real_ ##<<
-  ## Value of quality flag for data to plot
+  , QFVar = if (!missing(QFVar.s)) QFVar.s else 'none'     ##<< Quality
+  ##  flag of variable to be filled
+  , QFValue = if (!missing(QFValue.n)) QFValue.n else NA_real_ ##<< Value
+  ##  of quality flag for data to plot
   , Month = Month.i            ##<< Month to plot
-  , Legend = if (!missing(Legend.b)) Legend.b else T         ##<<
-  ## Plot with legend
+  , Legend = if (!missing(Legend.b)) Legend.b else T         ##<< Plot
+  ##  with legend
   , data = cbind(sDATA, sTEMP)   ##<< data.frame with variables to plot
   , dts = sINFO$DTS              ##<< numeric integer
   , Var.s               ##<< Variable to plot
@@ -409,7 +409,7 @@ sEddyProc$methods(sPlotFingerprint = sEddyProc_sPlotFingerprint)
       , month.name[Month], '!')
   }
 }
-sEddyProc$methods(.sPlotDiurnalCycleM = .sEddyProc_sPlotDiurnalCycleM)
+sEddyProc$methods(.sPlotDiurnalCycleM = sEddyProc_sPlotDiurnalCycleM)
 
 #+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
diff --git a/R/aEddy.R b/R/aEddy.R
index 14e57f1..25a3abc 100644
--- a/R/aEddy.R
+++ b/R/aEddy.R
@@ -469,3 +469,4 @@ sEddyProc$methods(sUpdateMethod = sEddyProc_sUpdateMethod)
 #     LatDeg=.self$sLOCATION$LatDeg, LongDeg=.self$sLOCATION$LongDeg,
 #     TimeZoneHour=.self$sLOCATION$TimeZoneHour)
 # })
+
diff --git a/man/sEddyProc_sPlotDiurnalCycleM.Rd b/man/sEddyProc_sPlotDiurnalCycleM.Rd
new file mode 100644
index 0000000..b8ef26a
--- /dev/null
+++ b/man/sEddyProc_sPlotDiurnalCycleM.Rd
@@ -0,0 +1,39 @@
+\name{sEddyProc_sPlotDiurnalCycleM}
+\alias{sEddyProc_sPlotDiurnalCycleM}
+\title{sEddyProc sPlotDiurnalCycleM}
+\description{The diurnal cycles of a single month are plotted to the current device,
+scaled to all data. Each year is plotted as a different (coloured) line.}
+\usage{sEddyProc_sPlotDiurnalCycleM(Var = Var.s, 
+    QFVar = if (!missing(QFVar.s)) QFVar.s else "none", 
+    QFValue = if (!missing(QFValue.n)) QFValue.n else NA_real_, 
+    Month = Month.i, Legend = if (!missing(Legend.b)) Legend.b else T, 
+    data = cbind(sDATA, sTEMP), dts = sINFO$DTS, 
+    Var.s, QFVar.s = "none", QFValue.n = NA_real_, 
+    Month.i, Legend.b = T)}
+\arguments{
+  \item{Var}{Variable to plot}
+  \item{QFVar}{Quality
+flag of variable to be filled}
+  \item{QFValue}{Value
+of quality flag for data to plot}
+  \item{Month}{Month to plot}
+  \item{Legend}{Plot
+with legend}
+  \item{data}{data.frame with variables to plot}
+  \item{dts}{numeric integer}
+  \item{Var.s}{Variable to plot}
+  \item{QFVar.s}{Quality flag of variable to be filled}
+  \item{QFValue.n}{Value of quality flag for data to plot}
+  \item{Month.i}{Month to plot}
+  \item{Legend.b}{Plot with legend}
+}
+
+
+
+\author{AMM, KS
+Department for Biogeochemical Integration at MPI-BGC, Jena, Germany <REddyProc-help@bgc-jena.mpg.de> [cph], Thomas Wutzler <twutz@bgc-jena.mpg.de> [aut, cre], Markus Reichstein <mreichstein@bgc-jena.mpg.de> [aut], Antje Maria Moffat <antje.moffat@bgc.mpg.de> [aut, trl], Olaf Menzer <omenzer@bgc-jena.mpg.de> [ctb], Mirco Migliavacca <mmiglia@bgc-jena.mpg.de> [aut], Kerstin Sickel <ksickel@bgc-jena.mpg.de> [ctb, trl], Ladislav <U+0160>igut <sigut.l@czechglobe.cz> [ctb]}
+
+
+
+
+