Merge branch 'devel'

Author: RLumSK

DESCRIPTION

@@ -1,8 +1,8 @@
 Package: RLumBuild
 Type: Package
 Title: RLum Universe Package Building
-Version: 0.1.7
-Date: 2024-02-12
+Version: 0.1.8.9000-8
+Date: 2024-08-20
 Author: Sebastian Kreutzer [aut, cre] (<https://orcid.org/0000-0002-0734-2199>),
     Christoph Burow [aut] (<https://orcid.org/0000-0002-5023-4046>)
 Authors@R: c(
@@ -36,4 +36,4 @@ Imports:
   xtable (>= 1.8-4)
 Encoding: UTF-8
 LazyData: true
-RoxygenNote: 7.3.1
+RoxygenNote: 7.3.2

NAMESPACE

@@ -24,6 +24,7 @@ export(module_update_zenodoJSON)
 export(module_verify_ExampleTimings)
 export(module_write_BibTeX)
 export(module_write_FunctionList)
+export(module_write_PDF_manual)
 export(module_write_codemetar)
 import(utils)
 importFrom(grDevices,dev.off)

NEWS.Rmd

@@ -8,7 +8,5 @@ header-includes:
 
 # News for package 'RLumBuild'
 
-## Changes in version `r RLumBuild::.get_pkg_version()` (`r Sys.Date()`)
-* `module_add_HowToCite()`: remove argument defunct by `stringi` 
-* `module_add_HowToCite()`: exclude `-package` file from parsing
-* `module_add_RLumTeam()`: exclude `-package` file from parsing
+* Fix `module_add_HowToCite()`
+* Add `module_write_PDF_manual()`

NEWS.md

@@ -7,8 +7,5 @@
 
 # News for package ‘RLumBuild’
 
-## Changes in version 0.1.7 (2024-02-12)
-
-- `module_add_HowToCite()`: remove argument defunct by `stringi`
-- `module_add_HowToCite()`: exclude `-package` file from parsing
-- `module_add_RLumTeam()`: exclude `-package` file from parsing
+- Fix `module_add_HowToCite()`
+- Add `module_write_PDF_manual()`

R/RLumBuild-package.R

@@ -26,6 +26,5 @@
 #' @importFrom grDevices dev.off pdf
 #' @importFrom graphics abline barplot text plot
 #'
-#' @docType package
 #' @md
-NULL
+"_PACKAGE"

R/build_package.R

@@ -154,9 +154,8 @@ build_package <- function(
   if(!"module_verify_ExampleTimings" %in% exclude)
     .run_module(text = "Verify example timings ...", f = module_verify_ExampleTimings())
 
-
   # # Build PDF manual ------------------------------------------------------------------------
-  .run_module(text = "Build PDF manual ...", f = devtools::build_manual(pkg = ".", path = paste0(pkg_name,".BuildResults/")))
+  .run_module(text = "Build PDF manual ...", f = module_write_PDF_manual())
 
   ## Outro  -------------------------------------------------------------------------------
   cat("\n")

R/module_add_HowToCite.R

@@ -83,7 +83,7 @@ module_add_HowToCite <- function(){
   file.list.man <- list.files("man/", recursive = TRUE, include.dirs = FALSE, pattern = "\\.Rd")
 
     ## remove package Rd, this causes some problems
-    file.list.man <- file.list.man[grepl("-package", file.list.man, fixed = TRUE)]
+    file.list.man <- file.list.man[!grepl("-package", file.list.man, fixed = TRUE)]
 
   # build package citation
   pkg.authors <- character()
@@ -224,7 +224,7 @@ module_add_HowToCite <- function(){
           ##write BibTeX file
           bib_file <- paste0(DESC_PACKAGE,".BuildResults/", DESC_PACKAGE,"_",DESC_VERSION,"-fun_bibliography.bib")
 
-          ##check if exsits or not
+          ##check if exits or not
           if(!file.exists(bib_file))
             write(x = character(), file = bib_file)
 

R/module_write_PDF_manual.R

@@ -0,0 +1,17 @@
+#' Create PDF Manual
+#'
+#' @description Build PDF Manual tar.gz is available
+#'
+#' @author Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany)
+#'
+#' @section Function version: 0.1.0
+#'
+#' @seealso [devtools::build_manual]
+#'
+#' @export
+module_write_PDF_manual <- function(){
+  devtools::build_manual(pkg = ".", path = paste0(.get_pkg_name(),".BuildResults/"))
+
+  return(TRUE)
+
+}