Package: goxygen 1.5.0

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 first (see pandoc.org).

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

goxygen_1.5.0.tar.gz
goxygen_1.5.0.zip(r-4.7)goxygen_1.5.0.zip(r-4.6)goxygen_1.5.0.zip(r-4.5)
goxygen_1.5.0.tgz(r-4.6-any)goxygen_1.5.0.tgz(r-4.5-any)
goxygen_1.5.0.tar.gz(r-4.7-any)goxygen_1.5.0.tar.gz(r-4.6-any)
goxygen_1.5.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION
card.svg |card.png
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.59 score 7 stars 5 scripts 307 downloads 11 exports 26 dependencies

Last updated from:17a9816a8d. Checks:9 OK. Indexed: yes.

Target	Result	Time
linux-devel-x86_64	OK	147
source / vignettes	OK	176
linux-release-x86_64	OK	148
macos-release-arm64	OK	116
macos-oldrel-arm64	OK	110
windows-devel	OK	100
windows-release	OK	111
windows-oldrel	OK	112
wasm-release	OK	149

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

Dependencies:citation cli desc digest dplyr 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

Rendered fromgoxygen.Rmdusingknitr::rmarkdown

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