tardoc: Generate Documentation and Analytics for targets Pipelines

2026-10-20

Version
0.6.0
Depends
R (>= 4.0)
Imports
targets, dplyr, purrr, roxygen2, Rd2md, jsonlite, rlang, withr
License
MIT + file LICENSE
Links
cathalbyrnegit.github.io
Browse source code
Report a bug
Author
Cathal Byrne [aut, cre]

R-CMD-check lint github-pages

Auto-generate documentation for any targets pipeline. Point tardoc at your project and get structured markdown, a browsable HTML viewer, and — optionally — a full analytics stack with SQL queries, semantic search and an LLM chat interface.

# install.packages("remotes")
remotes::install_github("CathalByrneGit/tardoc")

tardoc::document_targets(pkg_name = "My pipeline")
tardoc::view_tardoc()

The tardoc viewer showing an interactive targets pipeline dependency graph

Nothing in that screenshot is hand-written: every page, badge and graph comes from _targets.R and the roxygen comments in R/. It is the example pipeline in inst/examples/station-monitoring, published on every push — open the live demo.

1 What you get

document_targets() writes one .md per target and per function, plus two self-contained HTML files that open as file:// — no server, no R on the reader’s side:

Three optional layers go further: a live DuckDB server with semantic search, an LLM chat tab, and the pipeline database as an MCP server for Claude Desktop and Claude Code.

A store does not have to exist. tar_manifest() and tar_network() read _targets.R alone, so a pipeline that has never been run documents fully — with every target reading Not built, which is accurate rather than a gap.

2 Documentation

Full documentation is at cathalbyrnegit.github.io/tardoc:

3 Licence

MIT. See LICENSE.

Appendix

To cite the package tardoc in publications, please use:

Byrne C (2026). tardoc: Generate Documentation and Analytics for targets Pipelines. R package version 0.6.0, https://cathalbyrnegit.github.io/tardoc/.

@Manual{,
  title = {tardoc: Generate Documentation and Analytics for targets Pipelines},
  author = {Cathal Byrne},
  year = {2026},
  note = {R package version 0.6.0},
  url = {https://cathalbyrnegit.github.io/tardoc/},
}