Skip to content

README: link the gnparser installation guide - #346

Merged
kguidonimartins merged 1 commit into
masterfrom
docs/269-readme-gnparser
Oct 16, 2026
Merged

kguidonimartins merged 1 commit into
masterfrom
docs/269-readme-gnparser

Conversation

@kguidonimartins

Copy link
Copy Markdown
Collaborator

Summary

 #### **Installation**
   install.packages("bdc") / remotes::install_github("brunobrr/bdc")
   library(bdc)
+  `bdc_clean_names()` also needs gnparser, an external program not installed
+  with R packages -> link to the gnparser installation guide.
+  The other functions do not need it.
 #### **Package website**

Edited README.Rmd; README.md regenerated with make render (only this paragraph changed). The steps stay in one place, the installation guide rewritten in #340; this is why #271 was closed. Thanks to @black-snow for raising it.

bdc_clean_names() is the only function that calls gnparser (grep -l gnparser R/ → R/bdc_clean_names.R).

Evidence

  • Before: grep -i gnparser README.Rmd → no match.
    After: the Installation section names gnparser and links the guide (link returns HTTP 200).

Merge Danger

Door: two-way

Blast Radius: README

Text only.

Closes #269

🤖 Generated with Claude Code

https://claude.ai/code/session_019P8b9MT61Yto9NRYBksGtb

bdc_clean_names() needs the external gnparser program, which the README
never mentioned. Link the installation guide instead of repeating it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019P8b9MT61Yto9NRYBksGtb
@kguidonimartins
kguidonimartins merged commit bedf0ec into master Oct 16, 2026
5 checks passed
@kguidonimartins
kguidonimartins deleted the docs/269-readme-gnparser branch October 16, 2026 14:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add all requirements to install section

1 participant