breck7 / breck7/research

A checklist language?

Open
#19 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
17
Forks
0
PR merge metrics
No merged PRs in 30d

Description

While working on https://github.com/treenotation/dauscore ran into this idea.

How about a checklist like language. You would define a grammar like the below. Then you could just copy/paste the grammar into a new file and edit that file directly. It would also compile to a web form. And as you update the grammar, updating the programs wouldn't be a total pain.

```
Basics
This [synthesized|real] dataset is titled [string]
The data is [synthesized|real]
The project link is [url]

Specifications
The specLink is [url]
There are [integer] types/tables/kinds of entities
There are [integer] columns
There are [integer] columnTypes
The column domains [are|are not] appropriately reduced

Data
The downloadLink is [url]
The fileSize is [number] [byteUnit]
There are [integer] rows
The estimated number of potential rows in the domain is listed as [integer]

Tests
It [passes|fails] the copy/paste test
It [passes|fails] the goToDefinition test
It [passes|fails] the 1 click synth test
It [passes|fails] the cellCheck test
It [passes|fails] the download test
It [passes|fails] basic sanity tests
It [passes|fails] the reproduce from rawData test

Timeliness
The measurements span [number] [months|days|years|hours|minutes|seconds|other]

Future Work
The project lists [integer] missing columns that would be nice to have named [string[]]

Accuracy
The dataset contains [integer] missing cells
The dataset contains [integer] cellType errors

Provenance
The data collection steps [are|are not] listed
The machines used to gather the dataset [are|are not] listed
The batches and potential batch effects [are|are not] listed
Potential bias in the dataset [is|is not] explained
The rawData [is|is not] available
The specifications and code needed to process the raw data [are|are not] available

Auditing
The dataset [is|is not] version controlled
All rows and cells [are|are not] blameable
All authors and editors [are|are not] listed

Accessibility
The price to download the data and specs is [number]
A login [is|is not] required to download the data
The data [is|is not] released to the public domain
A direct link to the data [is|is not] available

Formats
The dataset [is|is not] available in CSV
The dataset [is|is not] available in TSV
The dataset [is|is not] available in SQL
The dataset [is|is not] available in JSON
The dataset [is|is not] available in ApacheArrow
The dataset [is|is not] available in XML

Schema Design
Format noise [has|has not been] minimized
The schema [is|is not isomorphic]

Normalization
The dataset contains [integer] duplicated rows
The dataset contains [integer] duplicated cells

Joinability
Common specified grammars and standards [are|are not] used
External grammars [are|are not] listed and specified
Data [is|is not] easy to join on orthogonal datasets```

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue names no implementation files, entry points, or tests to inspect, and the repository description says the folder was moved and the repository is archival. First confirm where this work now lives, then define the checklist language and web-form compilation scope before identifying its implementation and tests. Done should include an agreed grammar, compilation behavior, and validation coverage.

Written by the indexing model from the issue text.

Assessment

Domain
data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.