dataproofer-info-suite v2.1.0

suite-template

A template to write data checks for the Dataproofer desktop app or any JavaScript application.

• Documentation
• Repository
• Issues

Table of Contents

• Tests
  • numberOfRows.js
  • columnsContainNumbers.js
  • columnsContainNothing.js
• Development
  • Getting Started
  • Writing Tests
  • Building Docs

Tests

numberOfRows.js

src/numberOfRows.js:12-22

Count and display the number of rows

Parameters

• rows Array an array of objects representing rows in the spreadsheet
• columnHeads Array 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

• rows Array an array of objects representing rows in the spreadsheet
• columnHeads Array 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

• rows Array an array of objects representing rows in the spreadsheet
• columnHeads Array an array of strings for column names of the spreadsheet

Returns Object describing the result

Development

Getting Started

git clone git@github.com:dataproofer/info-suite.git
cd info-suite
npm install

Writing Tests

• How To
• Helper Scripts
• Templates
  • Basic Test
  • Advanced Test

Building Docs

We use documentation.js, but have created a handy script for regenerating documentation.

npm run docs

Then open up and check your docs in DOCUMENTATION.md