R Observatory: Metrics for goxygen version 1.4.5

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

goxygen

1.4.5

In-Code Documentation for 'GAMS'

0packages depend

2.7Kdownloads / year

94.4%test coverage

8/13checks pass

Overview

About

Maintained by Jan Philipp DietrichFirst published 2020-07-033 releasesCRAN page ↗GitHub ↗

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/).

Install

R (CRAN)pak (dev)Ubuntu (r2u)Fedora (COPR)openSUSE (OBS)

install.packages("goxygen", repos = "https://cloud.r-project.org/")

Installs the current CRAN release. Prebuilt binaries on Windows and macOS.

if (!requireNamespace("pak", quietly = TRUE))
  install.packages("pak", repos = "https://cloud.r-project.org/")
pak::pak("pik-piam/goxygen")

Development version from pik-piam/goxygen. Installs pak first if it is not already available.

Release

# enable cranapt (r2u) if it is not already set up, then install
grep -rqs r2u.stat.illinois.edu /etc/apt/sources.list /etc/apt/sources.list.d/ \
  || curl -fsSL https://raw.githubusercontent.com/eddelbuettel/r2u/master/inst/scripts/add_cranapt_noble.sh | sudo bash
sudo apt install -y r-cran-goxygen

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled.

bspm (used by r2u) also needs make: sudo apt install make

# enable the iucar/cran COPR if it is not already present, then install
ls /etc/yum.repos.d/*iucar*cran*.repo >/dev/null 2>&1 \
  || sudo dnf copr enable -y iucar/cran
sudo dnf install -y R-CRAN-goxygen

RPMs from the iucar/cran COPR, rebuilt from CRAN.

For install.packages() integration in R, also: sudo dnf install R-CoprManager

# add the autoCRAN OBS repo (Tumbleweed) if it is missing, then install
zypper -q lr | grep -qi autoCRAN \
  || sudo zypper addrepo https://download.opensuse.org/repositories/devel:/languages:/R:/autoCRAN/openSUSE_Tumbleweed/devel:languages:R:autoCRAN.repo
sudo zypper install -y R-goxygen

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed).

Health

CRAN checks

5NOTE8OK

Failing flavors

NOTE r-devel-linux-x86_64-debian-clang
NOTE r-devel-linux-x86_64-debian-gcc
NOTE r-devel-linux-x86_64-fedora-clang
NOTE r-devel-linux-x86_64-fedora-gcc
NOTE r-devel-windows-x86_64

Slowest check: 2.1 min · r-oldrel-windows-x86_64

Code health

Yes

Tests · ratio 0.12

94.4%

Coverage · measured lines

100%

Documentation · exports

6

Dependencies · direct

Check history

NOTE2026-07-16
11 OK · 2 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
OK2026-06-09
13 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
ERROR2026-06-08
12 OK · 0 NOTE · 0 WARNING · 1 ERROR · 0 FAILURE
OK2026-03-10
14 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE

Documentation

READMEYes · 216 wordsVignettesYes · dynamicpkgdown siteNoNEWSNoCode of conductNoContributing guideNo

Examples that run: 100%
Documented parameters: 100%
Return-value docs: 55%
References docs: 0%

Downloads

2.7K

CRAN downloads in the past year

Rank #15,618 · ~7/day · ~227/mo

Releases R versions

Daily download trend is not available in this view yet.

16530 days

69190 days

2.7K1 year

Compare downloads with other packages →

Also on90 r2u24 autocran

Repository

GitHub ↗ pik-piam/goxygen

7Stars

11Forks

0Open issues

0Open PRs

2Releases

233Commits

12Contributors

233 commits · Last activity 2026-04-02

Stars over time

2025-05-30 · 72026-07-07 · 7

Repository practices

Upstream repositoryBeta

9 development-tooling and community-health practices detected across 8 families in the upstream repository

Checks run against github.com/pik-piam/goxygen on 2026-08-23.

Continuous integration (1)

GitHub Actions

Reproducibility and dev environment (1)

Makefile

CRAN release process (1)

cran-comments.md

Research and citation (1)

CITATION.cff

Show all practices

Automation and maintenance (1)

pre-commit

Lint, format, editor (2)

lintrRStudio project

Coverage (1)

Codecov

Git structural (1)

.gitattributes

How this is detected·Detection ruleset v1 (2026-07-18)

Dependencies

Declared dependencies

11 external dependencies (excludes base and recommended)

Depends (0)

none

Imports (6)

pander stringi gms citation withr yaml

LinkingTo (0)

none

Suggests (5)

testthat knitr rmarkdown covr qgraph

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

Code & Tests

People & History

People (5)

Maintainer (1)

Jan Philipp Dietrich

Author, Maintainer

Authors (5)

Jan Philipp Dietrich

Author, Maintainer

Lavinia Baumstark

Author

Falk Benke

Author · added in 1.4.5

Kristine Karstens

Author

David Klein

Author

Package Timeline

3 releases. Pick two to compare their code metrics. R releases are shown for context.

R
R 4.6.0 released · 2026-04-24
R
R 4.5.0 released · 2025-04-11
1.4.5Latest
2025-04-01 · current release · diff ↗
R
R 4.4.0 released · 2024-04-24
R
R 4.3.0 released · 2023-04-21
R
R 4.2.0 released · 2022-04-22
R
R 4.1.0 released · 2021-05-18
1.0.3
2020-08-16 · diff ↗
unarchivedReturned to CRAN
2020-08-16
archivedRemoved from CRAN
2020-07-17
check problems were not corrected in time Does not declare pandoc in 'SystemRequirements' nor use it conditionally
1.0.2
2020-07-03
R
R 4.0.0 released · 2020-04-24

Package metadata

First published: 2020-07-03
Total releases: 3 / 6 yrs
License: BSD_2_clause + file LICENSE OSI
Download size: 111 KB
Installed size: not tracked yet
With dependencies: not tracked yet

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("goxygen")

The authors publish a CITATION.cff, so they have said how they want this cited. Run citation() and use what it gives you.

Cite the R Observatory

For a number measured here: a download total, a coverage figure, an archival date.

Format

APA

Balamuta, J. J. (2026). R Observatory: Metrics for goxygen version 1.4.5 [Data set]. HJJB, LLC. Data release v2026-08-25. https://doi.org/10.5281/zenodo.21843040

From data release v2026-08-25, which the citation names so these numbers can be found later. More on citing and the projects behind them.

Report a problem with this page →