Package: goxygen 1.4.4

Jan Philipp Dietrich

goxygen: In-Code Documentation for 'GAMS'

A collection of tools which extract a model documentation from 'GAMS' code and comments. In order to use the package you need to install 'pandoc' and 'pandoc-citeproc' first (<https://pandoc.org/>).

Authors:Jan Philipp Dietrich [aut, cre], Kristine Karstens [aut], David Klein [aut], Lavinia Baumstark [aut], Falk Benke [aut]

goxygen_1.4.4.tar.gz
goxygen_1.4.4.zip(r-4.5)goxygen_1.4.4.zip(r-4.4)goxygen_1.4.4.zip(r-4.3)
goxygen_1.4.4.tgz(r-4.4-any)goxygen_1.4.4.tgz(r-4.3-any)
goxygen_1.4.4.tar.gz(r-4.5-noble)goxygen_1.4.4.tar.gz(r-4.4-noble)
goxygen_1.4.4.tgz(r-4.4-emscripten)goxygen_1.4.4.tgz(r-4.3-emscripten)
goxygen.pdf |goxygen.html✨
goxygen/json (API)

# Install 'goxygen' in R:

install.packages('goxygen', repos = c('https://pik-piam.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/pik-piam/goxygen/issues

On CRAN:

5.43 score 6 stars 5 scripts 120 downloads 11 exports 27 dependencies

Last updated 11 months agofrom:3f566c77d7. Checks:OK: 5 NOTE: 2. Indexed: yes.

Target	Result	Date
Doc / Vignettes	OK	Dec 10 2024
R-4.5-win	NOTE	Dec 10 2024
R-4.5-linux	NOTE	Dec 10 2024
R-4.4-win	OK	Dec 10 2024
R-4.4-mac	OK	Dec 10 2024
R-4.3-win	OK	Dec 10 2024
R-4.3-mac	OK	Dec 10 2024

Exports:.empty buildHTML buildMarkdown buildTEX check_pandoc createIndexPage createModulePage createSimplePage extractDocumentation gamsequation2tex goxygen

Dependencies:citation cli desc digest dplyr fansi filelock generics glue gms jsonlite lifecycle magrittr pander pillar pkgconfig R6 Rcpp rlang stringi stringr tibble tidyselect utf8 vctrs withr yaml

Creating GAMS model documentations with goxygen

David Klein, Jan Philipp Dietrich

Rendered fromgoxygen.Rmdusingknitr::rmarkdownon Dec 10 2024.

Last update: 2023-11-23
Started: 2020-06-18

Citation

Development and contributors

Readme and manuals

Help Manual

Help page	Topics
.empty	.empty
.header	.header
.interfaceplot	.interfaceplot
.limitations	.limitations
.section	.section
.updateImagePaths	.updateImagePaths
.write	.write
appendExtraPageBlocks	appendExtraPageBlocks
buildHTML	buildHTML
buildMarkdown	buildMarkdown
buildTEX	buildTEX
check_pandoc	check_pandoc
chooseTemplate	chooseTemplate
createIndexPage	createIndexPage
createListModularCode	createListModularCode
createListSimpleCode	createListSimpleCode
createModulePage	createModulePage
createSimplePage	createSimplePage
extractDocumentation	extractDocumentation
flattenPageBlockList	flattenPageBlockList
gamsequation2tex	gamsequation2tex
goxygen	goxygen
oldBuildHTML	oldBuildHTML
returnReferences	returnReferences