Skip to content

Commit

Permalink
add docu of sPlotDiurnalCycleM
Browse files Browse the repository at this point in the history
  • Loading branch information
bgctw committed Jan 25, 2024
1 parent b568982 commit 8aa206b
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 9 deletions.
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
18 changes: 9 additions & 9 deletions R/EddyPlotting.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -409,7 +409,7 @@ sEddyProc$methods(sPlotFingerprint = sEddyProc_sPlotFingerprint)
, month.name[Month], '!')
}
}
sEddyProc$methods(.sPlotDiurnalCycleM = .sEddyProc_sPlotDiurnalCycleM)
sEddyProc$methods(.sPlotDiurnalCycleM = sEddyProc_sPlotDiurnalCycleM)

#+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

Expand Down
1 change: 1 addition & 0 deletions R/aEddy.R
Original file line number Diff line number Diff line change
Expand Up @@ -469,3 +469,4 @@ sEddyProc$methods(sUpdateMethod = sEddyProc_sUpdateMethod)
# LatDeg=.self$sLOCATION$LatDeg, LongDeg=.self$sLOCATION$LongDeg,
# TimeZoneHour=.self$sLOCATION$TimeZoneHour)
# })

39 changes: 39 additions & 0 deletions man/sEddyProc_sPlotDiurnalCycleM.Rd
Original file line number Diff line number Diff line change
@@ -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]}





0 comments on commit 8aa206b

Please sign in to comment.