Skip to content

mchlltt/inquirer-corrections

Repository files navigation

Inquirer Corrections

A command-line Node.js tool for collecting JSON data corrections from a user. Inquirer.js is the application's primary dependency.

radar-cleaning is a sibling repository, housing the data cleaning scripts that use the output of this tool.

Prerequisites

Getting Started

  • Run git clone https://github.com/mchlltt/inquirer-corrections.git or git clone [email protected]:mchlltt/inquirer-corrections.git to clone the repository.
  • Run npm install to install Inquirer and its dependencies.
  • Follow the data preparation instructions below.
  • Run npm start.

Data preparation

  • Fill out and remove the -template from corrections-template.json before use. corrections.json is included in .gitignore to protect you from pushing private information to GitHub.
  • If you would like to demo the app's functionality with synthetic data, the program will default to using the data in data/.
  • If you would like to use your own data, fill out and remove the -template from paths-template.js before use. paths.js is included in .gitignore in case you would like to keep the location of your data private.

License

This project is licensed under the MIT License - see the LICENSE file for details

Author

Mich Elliott - mchlltt

Built With

Acknowledgements

My time working on this project is funded by the NIH via Northwestern University's Institute for Sexual and Gender Minority Health and Wellbeing. Visit the RADAR Project's DokuWiki Codebook if you are interested in the study collecting the kind of data shown in the synthetic data.

Releases

No releases published

Packages

No packages published