dataproofer-info-suite
v2.1.0
Published
A set of informational scripts about Dataproofer spreadsheets
Readme
suite-template
A template to write data checks for the Dataproofer desktop app or any JavaScript application.
Table of Contents
Tests
numberOfRows.js
Count and display the number of rows
Parameters
rowsArray an array of objects representing rows in the spreadsheetcolumnHeadsArray an array of strings for column names of the spreadsheet
Returns Object describing the result
columnsContainNumbers.js
src/columnsContainNumbers.js:16-66
Determine the percentage of rows that are numbers for each column
Parameters
rowsArray an array of objects representing rows in the spreadsheetcolumnHeadsArray an array of strings for column names of the spreadsheet
Returns Object describing the result
columnsContainNothing.js
src/columnsContainNothing.js:16-67
Calculates the percentage of rows that are empty for each column
Parameters
rowsArray an array of objects representing rows in the spreadsheetcolumnHeadsArray an array of strings for column names of the spreadsheet
Returns Object describing the result
Development
Getting Started
git clone [email protected]:dataproofer/info-suite.git
cd info-suite
npm installWriting Tests
Building Docs
We use documentation.js, but have created a handy script for regenerating documentation.
npm run docsThen open up and check your docs in DOCUMENTATION.md
