Pakillo / Pakillo/grateful

Read output options from YAML

Open
#29 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
R
Stars
242
Forks
20
PR merge metrics
No merged PRs in 30d

Description

Would be good to be able to read options like the output format, citation processor (pandoc-citeproc or BibTeX), and any CSL files that are set in the document's YAML header, rather than having to also pass them to grateful. In particular:

  • cite_packages(…, citation.style)
  • nocite_references(…, citation_processor)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the cited cite_packages and nocite_references entry points and find where the document YAML header is read. Done means output format, citation processor, and CSL settings from that header are used without separately passing the corresponding options to grateful; verify both cited call paths.

Written by the indexing model from the issue text.

Assessment

Tech stack
r, yaml
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.