RLumBuild.BuildResults/RLumBuild_0.1.10-Functions_Markdown.md

In R-Lum/RLumBuild: RLum Universe Package Building

| Name | Title | Description | Version | m.Date | m.Time | Author | Citation | |:---------------------------------|:---------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------|:--------|:-------|:-------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | build_package | Check and Build Package | Central function to run the package build process. | 0.1.0 | NA | NA | Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) - , RLum Developer Team | Kreutzer, S., 2025. build_package(): Check and Build Package. Function version 0.1.0. In: Kreutzer, S., Burow, C., 2025. RLumBuild: RLum Universe Package Building. R package version 0.1.10. https://github.com/R-Lum/RLumBuild | | helpers | RLumBuild Helper Functions | Helper functions which are used internally to visualise the console output. Those functions are not in the overview, but are, however, documented | NA | NA | NA | Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) - , RLum Developer Team | Kreutzer, S., 2025. helpers(): RLumBuild Helper Functions. In: Kreutzer, S., Burow, C., 2025. RLumBuild: RLum Universe Package Building. R package version 0.1.10. https://github.com/R-Lum/RLumBuild | | module_add_HowToCite | Add How to Cite Section | Adds a function tailored section 'How to Cite' to each manual page as long as author names and a section 'Function version' exists. | NA | NA | NA | Christoph Burow (Germany), Sebastian Kreutzer, IRAMAT-CRP2A, UMR 5060, CNRS - Université Bordeaux Montaigne (France) - , RLum Developer Team | Burow, C., Kreutzer, S., 2025. module_add_HowToCite(): Add How to Cite Section. Function version 0.3.0. In: Kreutzer, S., Burow, C., 2025. RLumBuild: RLum Universe Package Building. R package version 0.1.10. https://github.com/R-Lum/RLumBuild | | module_add_RLumTeam | Module: add RLum-Team and update version timestamp | If the package was supported by the RLumTeam (the standard) the RLum-Team is added as author to all functions. | 0.1.0 | NA | NA | Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) - , RLum Developer Team | Kreutzer, S., 2025. module_add_RLumTeam(): Module: add RLum-Team and update version timestamp. Function version 0.1.0. In: Kreutzer, S., Burow, C., 2025. RLumBuild: RLum Universe Package Building. R package version 0.1.10. https://github.com/R-Lum/RLumBuild | | module_build_documentation | Module: Build Documentation | Create documentation using roxygen2 | 0.1.0 | NA | NA | Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) - , RLum Developer Team | Kreutzer, S., 2025. module_build_documentation(): Module: Build Documentation. Function version 0.1.0. In: Kreutzer, S., Burow, C., 2025. RLumBuild: RLum Universe Package Building. R package version 0.1.10. https://github.com/R-Lum/RLumBuild | | module_check_ReverseDependencies | Check Reverse Dependencies | Check the reverse dependencies of the package | 0.1.0 | NA | NA | Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) - , RLum Developer Team | Kreutzer, S., 2025. module_check_ReverseDependencies(): Check Reverse Dependencies. Function version 0.1.0. In: Kreutzer, S., Burow, C., 2025. RLumBuild: RLum Universe Package Building. R package version 0.1.10. https://github.com/R-Lum/RLumBuild | | module_compactVignette | Module: compact_Vignette | Try to further downsize the vignette, so far available | 0.1.0 | NA | NA | Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) - , RLum Developer Team | Kreutzer, S., 2025. module_compactVignette(): Module: compact_Vignette. Function version 0.1.0. In: Kreutzer, S., Burow, C., 2025. RLumBuild: RLum Universe Package Building. R package version 0.1.10. https://github.com/R-Lum/RLumBuild | | module_compile_Attributes | Module: Compile attributes | Compile C++ attributes if such code is part of the package | 0.1.0 | NA | NA | Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) - , RLum Developer Team | Kreutzer, S., 2025. module_compile_Attributes(): Module: Compile attributes. Function version 0.1.0. In: Kreutzer, S., Burow, C., 2025. RLumBuild: RLum Universe Package Building. R package version 0.1.10. https://github.com/R-Lum/RLumBuild | | module_create_DependencyGraph | Create Dependency Graph | Create package dependency graph | 0.1.0 | NA | NA | Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) - , RLum Developer Team | Kreutzer, S., 2025. module_create_DependencyGraph(): Create Dependency Graph. Function version 0.1.0. In: Kreutzer, S., Burow, C., 2025. RLumBuild: RLum Universe Package Building. R package version 0.1.10. https://github.com/R-Lum/RLumBuild | | module_knit_NEWS | Module: Knit NEWS | Create NEWS.md from NEWS.Rmd | 0.1.0 | NA | NA | Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) - , RLum Developer Team | Kreutzer, S., 2025. module_knit_NEWS(): Module: Knit NEWS. Function version 0.1.0. In: Kreutzer, S., Burow, C., 2025. RLumBuild: RLum Universe Package Building. R package version 0.1.10. https://github.com/R-Lum/RLumBuild | | module_knit_README | Module: Knit README | Create README.md from README.Rmd | 0.1.0 | NA | NA | Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) - , RLum Developer Team | Kreutzer, S., 2025. module_knit_README(): Module: Knit README. Function version 0.1.0. In: Kreutzer, S., Burow, C., 2025. RLumBuild: RLum Universe Package Building. R package version 0.1.10. https://github.com/R-Lum/RLumBuild | | module_set_VersionNumber | Module: set_VersionNumber | Automatically set version number in DESCRIPTION file if the pattern '.9000' is found. | 0.1.0 | NA | NA | Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) - , RLum Developer Team | Kreutzer, S., 2025. module_set_VersionNumber(): Module: set_VersionNumber. Function version 0.1.0. In: Kreutzer, S., Burow, C., 2025. RLumBuild: RLum Universe Package Building. R package version 0.1.10. https://github.com/R-Lum/RLumBuild | | module_update_datalist | Update datalist | Updates the file data/datalist if available. The standard CRAN functionality only works for data > 1 MB. For whatever reason. | 0.1.0 | NA | NA | Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) - , RLum Developer Team | Kreutzer, S., 2025. module_update_datalist(): Update datalist. Function version 0.1.0. In: Kreutzer, S., Burow, C., 2025. RLumBuild: RLum Universe Package Building. R package version 0.1.10. https://github.com/R-Lum/RLumBuild | | module_update_zenodoJSON | Module: Update .zenodo.json file | Automatically update the .zenodo.json file | 0.1.0 | NA | NA | Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) - , RLum Developer Team | Kreutzer, S., 2025. module_update_zenodoJSON(): Module: Update .zenodo.json file. Function version 0.1.0. In: Kreutzer, S., Burow, C., 2025. RLumBuild: RLum Universe Package Building. R package version 0.1.10. https://github.com/R-Lum/RLumBuild | | module_verify_ExampleTimings | Verify Example Timings | Check and display the timing results of the example checks to avoid too long example runs. | 0.1.0 | NA | NA | Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) - , RLum Developer Team | Kreutzer, S., 2025. module_verify_ExampleTimings(): Verify Example Timings. Function version 0.1.0. In: Kreutzer, S., Burow, C., 2025. RLumBuild: RLum Universe Package Building. R package version 0.1.10. https://github.com/R-Lum/RLumBuild | | module_write_BibTeX | Create Package BibTeX file | A BibTeX file to be used to cite the package is automatically created. | 0.1.0 | NA | NA | Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) - , RLum Developer Team | Kreutzer, S., 2025. module_write_BibTeX(): Create Package BibTeX file. Function version 0.1.0. In: Kreutzer, S., Burow, C., 2025. RLumBuild: RLum Universe Package Building. R package version 0.1.10. https://github.com/R-Lum/RLumBuild | | module_write_codemetar | Create Codemetar JSON-LD file | Add JSON-LD file file to make the package more tracable | 0.1.0 | NA | NA | Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) - , RLum Developer Team | Kreutzer, S., 2025. module_write_codemetar(): Create Codemetar JSON-LD file. Function version 0.1.0. In: Kreutzer, S., Burow, C., 2025. RLumBuild: RLum Universe Package Building. R package version 0.1.10. https://github.com/R-Lum/RLumBuild | | module_write_FunctionList | Write Function Argument List | Create a spread-sheet table with all function arguments Create a HTML and markdown list of all major functions in the package | 0.1.0 | NA | NA | Christoph Burow, Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) - - Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) - , RLum Developer Team | Burow, C., Kreutzer, S., 2025. module_write_FunctionList(): Write Function Argument List. Function version 0.1.0. In: Kreutzer, S., Burow, C., 2025. RLumBuild: RLum Universe Package Building. R package version 0.1.10. https://github.com/R-Lum/RLumBuild | | module_write_PDF_manual | Create PDF Manual | Build PDF Manual tar.gz is available | 0.1.0 | NA | NA | Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) - , RLum Developer Team | Kreutzer, S., 2025. module_write_PDF_manual(): Create PDF Manual. Function version 0.1.0. In: Kreutzer, S., Burow, C., 2025. RLumBuild: RLum Universe Package Building. R package version 0.1.10. https://github.com/R-Lum/RLumBuild |

R-Lum/RLumBuild documentation built on April 13, 2025, 4:47 p.m.