README.md

RmData

An open-source Homeless Management Information System (HMIS) custom reporting project.

This repository would be helpful to any HUD-designated Continuum of Care looking for a way to get more out of their HMIS data. While there are some reports here, this repository’s most important function is getting data from HMIS to a tidy form that can be used in other projects (and repositories). Think of it like a staging area for other projects.

Installation

You can install {RmData} with:

# install.packages("devtools")
devtools::install_github("COHHIO/RmData")

Data Sources

  1. The HUD CSV export - Every HMIS should be able to export this regardless of HMIS vendor.
  2. Other data as necessary, to supplement what is available in the Export.

While your reporting needs may be different, this report contains data we need for our reporting that is not included in the HUD CSVs. These include but are not limited to:

You may not need to supplement the data in your HUD CSV export, so whatever you use from this repository will need to be adjusted to leave it out. Or you may need a different set of miscellaneous data which will need to be incorporated to fit your needs. Other CoCs using this repository would need to work out what other data would be needed and how that data could be obtained.

If you want to know exactly what data I’m using, see below, and email me for more specifics if you need it.

Setup

The [clarity.looker]{https://github.com/COHHIO/clarity.looker} package provides a setup function for setting up an API connection with the Clarity Looker instance. An API key & secret will need to be requested.

Security

No HMIS data is ever included in this repository. To make this code work, you will need to supply your own HMIS data. You are responsible for securing your HUD CSV export on your computer and ensuring that it is not compromised using whatever security measures you use for that locally.



COHHIO/Rm_data documentation built on Dec. 9, 2024, 2:10 p.m.