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'))

Peer review:

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

On CRAN:

5.43 score 6 stars 4 scripts 131 downloads 11 exports 27 dependencies

Last updated 1 years agofrom:3f566c77d7. Checks:5 OK, 2 NOTE. Indexed: yes.

TargetResultLatest binary
Doc / VignettesOKJan 09 2025
R-4.5-winNOTEJan 09 2025
R-4.5-linuxNOTEJan 09 2025
R-4.4-winOKJan 09 2025
R-4.4-macOKJan 09 2025
R-4.3-winOKJan 09 2025
R-4.3-macOKJan 09 2025

Exports:.emptybuildHTMLbuildMarkdownbuildTEXcheck_pandoccreateIndexPagecreateModulePagecreateSimplePageextractDocumentationgamsequation2texgoxygen

Dependencies:citationclidescdigestdplyrfansifilelockgenericsgluegmsjsonlitelifecyclemagrittrpanderpillarpkgconfigR6Rcpprlangstringistringrtibbletidyselectutf8vctrswithryaml

Creating GAMS model documentations with goxygen

David Klein, Jan Philipp Dietrich

Rendered fromgoxygen.Rmdusingknitr::rmarkdownon Jan 09 2025.

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

Readme and manuals

Help Manual

Help pageTopics
.empty.empty
.header.header
.interfaceplot.interfaceplot
.limitations.limitations
.section.section
.updateImagePaths.updateImagePaths
.write.write
appendExtraPageBlocksappendExtraPageBlocks
buildHTMLbuildHTML
buildMarkdownbuildMarkdown
buildTEXbuildTEX
check_pandoccheck_pandoc
chooseTemplatechooseTemplate
createIndexPagecreateIndexPage
createListModularCodecreateListModularCode
createListSimpleCodecreateListSimpleCode
createModulePagecreateModulePage
createSimplePagecreateSimplePage
extractDocumentationextractDocumentation
flattenPageBlockListflattenPageBlockList
gamsequation2texgamsequation2tex
goxygengoxygen
oldBuildHTMLoldBuildHTML
returnReferencesreturnReferences