dataproofer-geo-suite v2.1.0

geo-suite

Suite of geographic and mapping related tests for Dataproofer

• Documentation
• Repository
• Issues

Table of Contents

• Tests
• voidLngLat.js
• validLngLat.js
• Development
  • Getting Started
  • Writing Tests
  • Building Docs

Tests

voidLngLat.js

src/voidLngLat.js:15-142

Verify that columns assumed to contain longitude or latitudes have non-zero values. These are values at 0º,0º.

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

validLngLat.js

src/validLngLat.js:14-146

Verify that columns assumed to contain longitude or latitudes have valid values. These are values above 180º or below -180º.

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

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 result an object describing the result

Development

Getting Started

git clone git@github.com:dataproofer/geo-suite.git
cd geo-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