{"id":14066577,"url":"https://github.com/emilyriederer/convo","last_synced_at":"2025-10-26T00:56:41.324Z","repository":{"id":54948799,"uuid":"313816722","full_name":"emilyriederer/convo","owner":"emilyriederer","description":"R package based on \"Column Names as Contracts\" blog post (https://emilyriederer.netlify.app/post/column-name-contracts/)","archived":false,"fork":false,"pushed_at":"2021-10-02T17:57:34.000Z","size":1262,"stargazers_count":31,"open_issues_count":4,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-10-11T22:09:08.970Z","etag":null,"topics":["controlled-vocabulary","data-quality","data-validation","r-package","schema-design","variable-names","variable-naming"],"latest_commit_sha":null,"homepage":"https://emilyriederer.github.io/convo/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/emilyriederer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-18T03:51:41.000Z","updated_at":"2025-10-06T09:33:58.000Z","dependencies_parsed_at":"2022-08-14T07:20:28.443Z","dependency_job_id":null,"html_url":"https://github.com/emilyriederer/convo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/emilyriederer/convo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emilyriederer%2Fconvo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emilyriederer%2Fconvo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emilyriederer%2Fconvo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emilyriederer%2Fconvo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/emilyriederer","download_url":"https://codeload.github.com/emilyriederer/convo/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emilyriederer%2Fconvo/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281043400,"owners_count":26434444,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-25T02:00:06.499Z","response_time":81,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["controlled-vocabulary","data-quality","data-validation","r-package","schema-design","variable-names","variable-naming"],"created_at":"2024-08-13T07:05:10.235Z","updated_at":"2025-10-26T00:56:41.290Z","avatar_url":"https://github.com/emilyriederer.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"# convo \u003cimg src='man/figures/logo.png' align=\"right\" height=\"138\" /\u003e\n\n\u003c!-- badges: start --\u003e\n[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)\n[![R build status](https://github.com/emilyriederer/convo/workflows/R-CMD-check/badge.svg)](https://github.com/emilyriederer/convo/actions)\n[![Coverage status](https://codecov.io/gh/emilyriederer/convo/branch/master/graph/badge.svg?token=oQJuMACP9O)](https://codecov.io/gh/emilyriederer/convo)\n\u003c!-- badges: end --\u003e\n\nThe goal of `convo` is to enable the creation of a a controlled vocabularly for naming columns in a relational dataset as described in my blog post [Column Names as Contracts](https://emilyriederer.netlify.app/post/column-name-contracts/). This controlled vocabularly can then be used to check a set of names for adherence, to automate documentation, and to generate data checks via the `pointblank` package.\n\n## Installation\n\nYou can install the development version of convo from GitHub with:\n\n``` r\ndevtools::install_github(\"emilyriederer/convo\")\n```\n\n## Features\n\n### Available\n\n- Define controlled vocabularly (a `convo`) in R or YAML including valid name stubs at different levels of the ontology and optional descriptions or validation checks\n- Parse stub lists (candidate `convo`s) from a set of variables\n- Evaluate if a set of names adheres to a `convo` and identify violations\n- Compare `convo` objects and/or stub lists with set-like operations (union, intersect, setdiff) to identify new candidates for inclusion\n- Generate a `pointblank` validation agent or YAML file from a `convo` object for data validation\n- Document a dataset with network diagrams or a table \n\n### Current Limitations / Future Enhancements\n\n- Define overall metadata for controlled vocabularly metadata such as:\n  + overall descriptor string\n  + human-readable names describing each level\n- Richer control over levels. Currently can only evaluate starting from the front, but in the future could:\n  + allow some levels to be optional\n  + work from both front and the back\n- Current levels are independent of one another\n  + could allow for truly hierarchical ontologies where allowed level 2 stubs vary by level 1 stub used\n- Current assumption is that realizations of a controlled vocabularly are all delimited by the same separator\n  + to work better with filepaths, might potentially want to enable multiple types of delimeters\n- Current regex support slightly unreliable. Need to better document and expand\n- More aesthetic documentation (`describe_*()` functions)\n- Better set operations for combining instead of overwriting full `convo` specifications (not just stub lists)\n- Explore integration with `dm` package to validate names across a schema\n\n## Example\n\nMain pieces of functionality are illustrated in the [Quick Start Guide](https://emilyriederer.github.io/convo/articles/quickstart-guide.html) on the package website.\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femilyriederer%2Fconvo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femilyriederer%2Fconvo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femilyriederer%2Fconvo/lists"}