Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 7 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.6%) to scientific vocabulary
Repository
Documentation package for modular GAMS code
Basic Info
- Host: GitHub
- Owner: pik-piam
- License: other
- Language: R
- Default Branch: master
- Size: 324 KB
Statistics
- Stars: 7
- Watchers: 2
- Forks: 9
- Open Issues: 0
- Releases: 2
Metadata Files
README.md
In-Code Documentation for 'GAMS'
R package goxygen, version 1.4.6
Purpose and Functionality
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).
Installation
For installation of the most recent package version an additional repository has to be added in R:
r
options(repos = c(CRAN = "@CRAN@", pik = "https://rse.pik-potsdam.de/r/packages"))
The additional repository can be made available permanently by adding the line above to a file called .Rprofile stored in the home folder of your system (Sys.glob("~") in R returns the home directory).
After that the most recent version of the package can be installed using install.packages:
r
install.packages("goxygen")
Package updates can be installed using update.packages (make sure that the additional repository has been added before running that command):
r
update.packages()
Tutorial
The package comes with a vignette describing the basic functionality of the package and how to use it. You can load it with the following command (the package needs to be installed):
r
vignette("goxygen") # Creating GAMS model documentations with goxygen
Questions / Problems
In case of questions / problems please contact Jan Philipp Dietrich dietrich@pik-potsdam.de.
Citation
To cite package goxygen in publications use:
Dietrich J, Karstens K, Klein D, Baumstark L, Benke F (2025). "goxygen: In-Code Documentation for 'GAMS'." doi:10.5281/zenodo.1411404 https://doi.org/10.5281/zenodo.1411404, Version: 1.4.6, https://github.com/pik-piam/goxygen.
A BibTeX entry for LaTeX users is
latex
@Misc{,
title = {goxygen: In-Code Documentation for 'GAMS'},
author = {Jan Philipp Dietrich and Kristine Karstens and David Klein and Lavinia Baumstark and Falk Benke},
doi = {10.5281/zenodo.1411404},
date = {2025-04-10},
year = {2025},
url = {https://github.com/pik-piam/goxygen},
note = {Version: 1.4.6},
}
Owner
- Name: Potsdam Integrated Assessment Modelling (PIAM)
- Login: pik-piam
- Kind: organization
- Location: Potsdam Institute for Climate Impact Research (PIK), Germany
- Website: https://www.pik-potsdam.de/
- Repositories: 50
- Profile: https://github.com/pik-piam
Tools developed for use with data and models related to PIK's research.
Citation (CITATION.cff)
cff-version: 1.2.0 message: If you use this software, please cite it using the metadata from this file. type: software title: 'goxygen: In-Code Documentation for ''GAMS''' version: 1.4.6 date-released: '2025-04-10' abstract: 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: - family-names: Dietrich given-names: Jan Philipp email: dietrich@pik-potsdam.de - family-names: Karstens given-names: Kristine email: karstens@pik-potsdam.de - family-names: Klein given-names: David email: dklein@pik-potsdam.de - family-names: Baumstark given-names: Lavinia email: lavinia@pik-potsdam.de - family-names: Benke given-names: Falk email: benke@pik-potsdam.de license: BSD-2-Clause repository-code: https://github.com/pik-piam/goxygen doi: 10.5281/zenodo.1411404
GitHub Events
Total
- Watch event: 1
- Issue comment event: 3
- Push event: 3
- Pull request event: 3
- Fork event: 2
Last Year
- Watch event: 1
- Issue comment event: 3
- Push event: 3
- Pull request event: 3
- Fork event: 2
Committers
Last synced: about 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| Jan Philipp Dietrich | d****h@p****e | 125 |
| David Klein | d****n@p****e | 23 |
| Falk Benke | f****e@p****e | 21 |
| Pascal Führlich | p****h@p****e | 19 |
| Kristine Karstens | k****s@p****e | 4 |
| Lavinia Baumstark | b****k@p****e | 4 |
| Johannes Koch | j****h@p****e | 2 |
| Michaja Pehl | p****l@p****e | 1 |
| bodirsky | b****y@p****e | 1 |
| giannou | g****u@p****e | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 4
- Total pull requests: 26
- Average time to close issues: 3 months
- Average time to close pull requests: about 1 month
- Total issue authors: 3
- Total pull request authors: 7
- Average comments per issue: 1.0
- Average comments per pull request: 1.15
- Merged pull requests: 19
- Bot issues: 0
- Bot pull requests: 6
Past Year
- Issues: 0
- Pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: 5 months
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 1.5
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 1
Top Authors
Issue Authors
- 0UmfHxcvx5J7JoaOhFSs5mncnisTJJ6q (2)
- fbenke-pik (1)
- orichters (1)
Pull Request Authors
- dklein-pik (8)
- pre-commit-ci[bot] (8)
- fbenke-pik (6)
- pfuehrlich-pik (4)
- pascal-sauer (2)
- whitehacker (1)
- tscheypidi (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- cran 236 last-month
- Total dependent packages: 0
- Total dependent repositories: 19
- Total versions: 3
- Total maintainers: 1
cran.r-project.org: goxygen
In-Code Documentation for 'GAMS'
- Homepage: https://github.com/pik-piam/goxygen
- Documentation: http://cran.r-project.org/web/packages/goxygen/goxygen.pdf
- License: BSD_2_clause + file LICENSE
-
Latest release: 1.4.5
published 11 months ago
Rankings
Maintainers (1)
Dependencies
- citation * imports
- gms * imports
- pander * imports
- stringi * imports
- withr * imports
- yaml * imports
- covr * suggests
- knitr * suggests
- qgraph * suggests
- rmarkdown * suggests
- testthat * suggests
- actions/checkout v2 composite
- actions/setup-python v2 composite
- pat-s/always-upload-cache v3 composite
- r-lib/actions/setup-pandoc v1 composite