/mfcdm

MFCDM takes the data collected from the individuals' burials and compiles it into one monolithic database

Primary LanguageTypeScript

MetFern Cemetery Data Manipulation (MFCDM)

MFCDM takes the data collected from the individuals' burials and compiles it into one monolithic database as well as running analytics on that data

Click here to learn more about the MetFern Cemetery and how you can help.

More Info

The goal of this project is to take data entered manually by hand and data entered automatically by form submission, and to combine the data through automated form submission so that the merged data forms a common schema for future analysis.

Getting Started

Prerequisites

This is a Node.js application.

Before installing, download and install Node.js.

Installing

  1. Clone the repository
$ git clone https://github.com/jdtzmn/mfcdm
$ cd mfcdm
  1. Install dependencies
$ npm install
  1. Create input folder
$ mkdir input

Usage

Converters

Create a converter.js file in the input folder (any name will work)

const Mfcdm = require('../dist/mfcdm')
const mfcdm = new Mfcdm()

const converter = async (sheetName, sheetRow) => {
  /* code here */
}

mfcdm.setConverter('converter name', converter)
mfcdm.start() // starts the mfcdm cli

Analyzers

Create a analyzer.js file in the input folder (any name will work)

const Mfcdm = require('../dist/mfcdm')
const mfcdm = new Mfcdm()

const analyzer = async (name, sheet) => {
  /* code here */

  return {
    'Statistic Label': 'value'
  }
}

mfcdm.setAnalyzer('analyzer name', analyzer)
mfcdm.start() // starts the mfcdm cli

Run the code (a menu will ask whether to analyze or convert)

node input/converter.js
# or
node input/analyzer.js

Authors

  • Jacob Daitzman - Initial work - jdtzmn

Changelog

To view the changelog, click here.

License

This project is left unlicensed on purpose, which means it is under exclusive copyright at the moment.