Package: okf 0.5.2

Travis Jakel

okf: Open Knowledge Format (OKF) Ingestion

Read, validate, and load Open Knowledge Format (OKF) bundles (a directory of markdown files with YAML frontmatter) into a portable DuckDB catalog, build the concept graph, render to HTML, and optionally embed concept bodies for semantic search. Deterministic and agent-free: the same bundle always yields the same catalog, graph, and render, with no LLM calls in the core. Conformant and permissive per the OKF v0.1 specification.

Authors:Travis Jakel [aut, cre]

okf_0.5.2.tar.gz
okf_0.5.2.tar.gz(r-4.7-any)okf_0.5.2.tar.gz(r-4.6-any)
okf_0.5.2.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION
card.svg |card.png
okf/json (API)

# Install 'okf' in R:
install.packages('okf', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org'))

On CRAN:

Conda:

This package does not link to any Github/Gitlab/R-forge repository. No issue tracker or development information is available.

1.00 score 26 exports 5 dependencies

Last updated from:55e64e2cb0. Checks:4 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK122
source / vignettesOK170
linux-release-x86_64OK123
wasm-releaseOK98

Exports:okf_backlinksokf_chunk_bodyokf_clustersokf_conceptsokf_contextokf_doctorokf_doctor_fixokf_embedokf_extract_linksokf_fetchokf_findingsokf_graph_dfokf_graph_htmlokf_graph_jsonokf_graph_mermaidokf_htmlokf_impactokf_ingestokf_linksokf_ollama_embedderokf_parse_fileokf_ragokf_readokf_resolve_linkokf_searchokf_validate

Dependencies:DBIdigestduckdbjsonliteyaml

Readme and manuals

Help Manual

Help pageTopics
Concepts that link to a given concept ("linked from" / backlinks).okf_backlinks
Split a concept body into chunks on paragraph boundaries.okf_chunk_body
Deterministic community labels via synchronous label propagation.okf_clusters
Assemble an index-first, link-following slice of a bundle as one markdown blob for direct LLM consumption.okf_context
Health / maintenance report for an ingested OKF catalog.okf_doctor
Apply only unambiguously-safe maintenance fixes to a bundle's source files.okf_doctor_fix
Chunk and embed concept bodies into the catalog for semantic search.okf_embed
Extract markdown link targets from a concept body (OKF cross-links, sec. 4).okf_extract_links
Materialize an OKF bundle from a directory, git URL, or tar/zip archive.okf_fetch
Render the concept graph as one self-contained interactive HTML page.okf_graph_html
Export the concept graph as portable JSON (nodes and edges).okf_graph_json
Render the concept graph as a Mermaid `graph LR` diagram.okf_graph_mermaid
Render an ingested OKF catalog to HTML for viewing.okf_html
Link-impact ("ripple") of a concept.okf_impact
Ingest an OKF bundle into a DuckDB catalog.okf_ingest
Build the concept graph (resolved and broken links) for a bundle.okf_links
Build an embedder backed by a local Ollama embeddings model.okf_ollama_embedder
Parse the YAML frontmatter and body of a single OKF concept file.okf_parse_file
Query helpers over an ingested OKF catalog.okf_concepts okf_findings okf_graph_df okf_query okf_search
Semantic search over an embedded catalog.okf_rag
Read an OKF bundle from a directory into an in-memory representation.okf_read
Resolve a markdown link target to a bundle-relative concept path.okf_resolve_link
Validate a bundle against the OKF v0.1 conformance rules (permissively).okf_validate