toolWriteMadratLog

.buildlibrary

@@ -1,4 +1,4 @@
-ValidationKey: '1191000'
+ValidationKey: '1390900'
 AutocreateReadme: yes
 AcceptedWarnings:
 - 'Warning: package ''.*'' was built under R version'

CITATION.cff

@@ -4,8 +4,8 @@ type: software
 title: |-
   mstools: Tool functions that can be used by several madrat-dependent or
       magpie4 output functions
-version: 0.6.0
-date-released: '2024-05-07'
+version: 0.7.0
+date-released: '2024-05-27'
 abstract: Tool functions that can be used by several madrat-dependent or magpie4 output
   functions.
 authors:

DESCRIPTION

@@ -2,8 +2,8 @@ Type: Package
 Package: mstools
 Title: Tool functions that can be used by several madrat-dependent or
     magpie4 output functions
-Version: 0.6.0
-Date: 2024-05-07
+Version: 0.7.0
+Date: 2024-05-27
 Authors@R: c(
     person("Benjamin Leon", "Bodirsky", , "[email protected]", role = c("aut", "cre")),
     person("Kristine", "Karstens", role = "aut"),

NAMESPACE

@@ -19,6 +19,7 @@ export(toolIsocode2Country)
 export(toolSmooth)
 export(toolStatusMessage)
 export(toolSum2Country)
+export(toolWriteMadratLog)
 import(madrat)
 import(magclass)
 importFrom(madrat,toolAggregate)

R/toolExpectTrue.R

@@ -12,7 +12,8 @@
 #' up by one in the call stack, \code{level = -1} will use \code{toolExpectTrue} itself as
 #' function call.
 #' @author Jan Philipp Dietrich
-#' @seealso \code{\link{getMadratMessage}}, \code{\link{toolExpectLessDiff}}, \code{\link{toolStatusMessage}}
+#' @seealso \code{\link{getMadratMessage}}, \code{\link{toolExpectLessDiff}},
+#' \code{\link{toolStatusMessage}}, \code{\link{toolWriteMadratLog}}
 #' @examples
 #' toolExpectTrue(is.numeric(1), "data is numeric", level = -1)
 #' getMadratMessage("status")

R/toolWriteMadratLog.R

@@ -0,0 +1,20 @@
+#' toolWriteMadratLog
+#'
+#' Tool function for writing madrat messages to a log file. Useful
+#' after running madrat calculations which are performing checks via
+#' \code{\link{toolExpectTrue}} or other toolExpect functions.
+#' @param checkResults list of check results as returned by \code{\link{getMadratMessage}}
+#' @param logPath path to the log file to be written
+#' @author Pascal Sauer
+#' @export
+toolWriteMadratLog <- function(checkResults = getMadratMessage("status"), logPath = "status.log") {
+  consistencyCheckLog <- NULL
+  for (i in seq_along(checkResults)) {
+    consistencyCheckLog <- paste(c(consistencyCheckLog,
+                                   names(checkResults)[[i]],
+                                   checkResults[[i]],
+                                   ""),
+                                 collapse = "\n")
+  }
+  writeLines(consistencyCheckLog, logPath)
+}

README.md

@@ -1,7 +1,7 @@
 # Tool functions that can be used by several madrat-dependent or
     magpie4 output functions
 
-R package **mstools**, version **0.6.0**
+R package **mstools**, version **0.7.0**
 
 [![CRAN status](https://www.r-pkg.org/badges/version/mstools)](https://cran.r-project.org/package=mstools) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1158582.svg)](https://doi.org/10.5281/zenodo.1158582) [![R build status](https://github.com/pik-piam/magpie4/workflows/check/badge.svg)](https://github.com/pik-piam/magpie4/actions) [![codecov](https://codecov.io/gh/pik-piam/magpie4/branch/master/graph/badge.svg)](https://app.codecov.io/gh/pik-piam/magpie4) [![r-universe](https://pik-piam.r-universe.dev/badges/mstools)](https://pik-piam.r-universe.dev/builds)
 
@@ -40,7 +40,7 @@ In case of questions / problems please contact Benjamin Leon Bodirsky <bodirsky@
 
 To cite package **mstools** in publications use:
 
-Bodirsky B, Karstens K, Beier F, Dietrich J (2024). _mstools: Tool functions that can be used by several madrat-dependent or magpie4 output functions_. doi:10.5281/zenodo.1158582 <https://doi.org/10.5281/zenodo.1158582>, R package version 0.6.0, <https://github.com/pik-piam/magpie4>.
+Bodirsky B, Karstens K, Beier F, Dietrich J (2024). _mstools: Tool functions that can be used by several madrat-dependent or magpie4 output functions_. doi:10.5281/zenodo.1158582 <https://doi.org/10.5281/zenodo.1158582>, R package version 0.7.0, <https://github.com/pik-piam/magpie4>.
 
 A BibTeX entry for LaTeX users is
 
@@ -50,7 +50,7 @@ A BibTeX entry for LaTeX users is
 magpie4 output functions},
   author = {Benjamin Leon Bodirsky and Kristine Karstens and Felicitas Beier and Jan Philipp Dietrich},
   year = {2024},
-  note = {R package version 0.6.0},
+  note = {R package version 0.7.0},
   url = {https://github.com/pik-piam/magpie4},
   doi = {10.5281/zenodo.1158582},
 }