Giter Club home page Giter Club logo

openwashdata / cbssuitabilityhaiti Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 17.11 MB

Data for a sanitation zoning assessment prepared for the city of Cap Haitien, Haiti. The package combines two datasets used for an analysis of the suitability of container-based sanitation (CBS)

Home Page: https://openwashdata.github.io/cbssuitabilityhaiti/

License: Creative Commons Attribution 4.0 International

R 100.00%
central-america haiti open-data open-datasets r sanitation suitability-analysis wash container-based-sanitation

cbssuitabilityhaiti's Introduction

cbssuitabilityhaiti

DOI R-CMD-check License: CC BY 4.0

The goal of cbssuitabiility is to provide datasets for research and planning of water and solid waste management in Cap Haïtien, Haiti. This package combines datasets collected as part of two different projects. The package includes geospatial data about the locations of water access points and data from a sanitation zoning report for the municipality of Cap Haïtien.

Installation

You can install the development version of cbssuitabilityhaiti from GitHub with:

# install.packages("devtools")
devtools::install_github("openwashdata/cbssuitabilityhaiti")

Alternatively, you can download the individual datasets as a CSV or XLSX file from the table below.

dataset CSV XLSX
okap Download CSV Download XLSX
mwater Download CSV Download XLSX

Datasets

This data package has two datasets, mwater and okap.

mwater

Water point data for the city of Cap Haitien, Haiti. The data collection and characterization was done between 2016 and 2022.

library(cbssuitabilityhaiti)

The mwater data set has 7 variables and 1849 observations. For an overview of the variable names, see the following table.

mwater 
variable_name variable_type description
latitude double Lattitude coordinate
longitude double Longitude coordinate
administra character Communal section- smallest administrative unit in Haiti
type character Type of water access point
date_added double Date water access point was added to mWater
datasets character Dataset in mWater that point is part of, including organizaiton that is responsible for data
geometry list Geospatial data of the different access points that were added to mWater

Below is a map of the water points in this dataset.

Locations of water access points in this dataset

Locations of water access points in this dataset

Projet Eau et Assainissement de l’USAID

Sanitation zoning assessment for the Cap Haïtien, Haiti region.

Description

The study, based on three basic criteria (physical, urban characteristics and socioeconomic constraints of the zones), divides the Cap-Haïtien metropolitan area into homogeneous zones in order to propose adapted sanitation solutions for each zone based on a set of predefined criteria.

Data

This data includes data from a sanitation zoning report done for the city of Cap Haïtien, Haiti in 2022. Additionally, it contains spatial data about the neighborhoods of 5 different Haïtien cities. The attribute table includes data on population density, socioeconomic status, suitability of pit latrines, and suggested sewage construction priority zones.

These data were developed under the USAID Water and Sanitation Project in collaboration with the Cap-Haitian municipal government and DINEPA. These data do not reflect the opinion of USAID or the US Government.

library(cbssuitabilityhaiti)

The okap data set has 13 variables and 198 observations. For an overview of the variable names, see the following table.

okap
variable_name variable_type description
neighborho double Unique identifying number for each neighborhood unit
name character Name of each nieghborhood unit
sup_km2 double Area of neighborhood in square km
cte character Name of commune (administrative unit in Haiti)
economy character Categorical socioeconomic status (low, medium)
sup_bati_km2 double area of neihborhood covered by buildings in square kilometers
density integer Categorical population density (least dense, somewhat dense, dense, very dense, most dense)
aptitude character suitability of the site for a wastewater treatment system
zoning character “group” if collective or grouped sanitation is possible in short term.
latrine character Suggested pit latrine and septic allowance (allowed, not allowed)
density_ra double Catgoriccal population density according to the description of the variable “density” (values from 1 to 5)
economy_nu double Categotical socioeconomic status according to the description of the variable “economy” (1=low, 2 = medium)
geometry list Geospatial data of the neighborhood stored as a polygon

Source

https://data.humdata.org/dataset/cap-haitien-haiti-sanitation-zoning-assessment

Examples

The code below is an example which shows how you could use the data to prepare a map in R. Find this and more examples in the prepared examples article (vignette("examples")).

library(cbssuitabilityhaiti)
library(tidyverse)
library(sf)
library(tmap)


## create an interactive map for cap haitien

# set mapping mode to interactive ("view")
tmap_mode("view")

# create first map layer: neighborhood areas
tm_shape(filter(okap, cte == "ctecaphaitien")) +
  tm_borders() +
  tm_fill(alpha = 0.6) +
  # create second map layer: locations and type of the water points
  tm_shape(drop_na(st_join(mwater, okap), neighborho)) +
  tm_dots(col = "type", palette = "PuRd")
Screenshot of the an interactive map with OpenStreetMap layer.

Screenshot of the an interactive map with OpenStreetMap layer.

License

Data are available as CC-BY.

Citation

Please cite using:

citation("cbssuitabilityhaiti")
#> To cite package 'cbssuitabilityhaiti' in publications use:
#> 
#>   Loos S, Kramer S, Lubeck-Schricker M (2023). "cbssuitabilityhaiti:
#>   Data for a sanitation zoning assessment done for Cap Haitien, Haiti."
#>   doi:10.5281/zenodo.8361085 <https://doi.org/10.5281/zenodo.8361085>.
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Misc{looskramer,
#>     title = {cbssuitabilityhaiti: Data for a sanitation zoning assessment done for Cap Haitien, Haiti},
#>     author = {Sebastian Camilo Loos and Sasha Kramer and Maya Lubeck-Schricker},
#>     doi = {10.5281/zenodo.8361085},
#>     year = {2023},
#>     abstract = {This package contains data for a sanitation zoning assessment done for the city of Cap Haitien, Haiti. It combines two datasets used for an analysis of the suitability of container-based sanitation (CBS).},
#>     version = {0.0.1},
#>   }

Additional data use information

Anyone interested in publishing the data:

  • Sanitation zoning assessment data (okap) should be attributed with “These data were developed under the USAID Water and Sanitation Project in collaboration with the Cap-Haitian municipal government and DINEPA. These data do not reflect the opinion of USAID or the US Government.”

cbssuitabilityhaiti's People

Contributors

larnsce avatar mayalubecks avatar mianzg avatar sebastian-loos avatar

Stargazers

 avatar

Watchers

 avatar

cbssuitabilityhaiti's Issues

Provide authors/contributors information

Hey @mayalubecks

I had a look into the datasets and I am excited about its content. Since one of the main goals of the openwashdata project is to give credit to all contributors to a dataset, we would like you to add the author information for the datasets to the repository.

You can do it in a similar way as you did with the dictionary.

Step 1

You can download the authors.xlsx file from the following link:

https://github.com/openwashdata/cbssuitabilityhaiti/raw/main/data-raw/authors.xlsx

Step 2

Open the file on your computer and fill in the rows with the authors information:

  • first_name, given names
  • last_name, last names
  • email
  • role, provide one or more three-letter codes specifying the role of the contributor.
    These are the most common ones:
    cre: creator or maintainer, maintains the package and is the contact person
    aut: authors, made significant contributions
    ctb: contributors, made smaller contributions
    dtc: data contributor, contributed data sets
    fnd: funder
  • orcid, add the authors/contributors Orcid number so that the data package can be linked automatically later on.

There are two examples already in the spread sheet.

Step 3

Upload the completed authors.xlsx file back into the data-raw folder using the same steps as in Issue #1.

Please feel free to add all known contributors, also the people who conducted/supervised a survey/interview or collected spatial data points for example. This way, everybody can get acknowledged and have a reference to show.

If you have any questions please go ahead and contact me.
Thank you very much for working through this with us!

Add raw data for data-raw folder

Hi @mayalubecks

I have prepared a repository for your data. (Repo)sitory, is a fancy name for a folder/directory and you can picture it just like a folder that sits on your computer. You were added to the repo as collaborator, please accept that invitation.

We will communicate and collaborate here using the so-called issue tracker. It helps us track organise tasks and track progress, but maybe most importantly, it reduces the number of emails in our inbox. :)

You can respond here any time if you have questions or need support.

Task 1: become a collaborator

  • Accept the invitation from GitHub to join this repo as a collaborator

Task 2: add your data to the repository

Your task now would be to add your raw data to the data-raw folder. You can do this directly here on GitHub, following these steps:

Step 1

Step 2

  • Open the data-raw folder

Screenshot 2023-04-06 at 15 50 15

Step 3

  • Click on "Add file -> Upload files"

Screenshot 2023-04-06 at 15 50 35

Step 4

  • Add your files
  • Commit changes (this associates your GitHub username as a contribution to this repository)

Screenshot 2023-04-06 at 15 50 56

Step 5

  • Let me know that you have submitted the data by responding to this issue and mention me using my GitHub handle @larnsce

Dataset documentation

Hey @mayalubecks

As the next step to the final package, we will have to populate the package documentation.

I did go ahead and added basic information about the package and its purpose. I also added the dataset informationfor the sanitation assessment data here and some maps for the visualization of the data.

Now I need a little help from you since I'm not as familiar with the mWater data set..

I would be very grateful if you could give me the following information:

  • Catch phrase:
    • One catchy sentence that explains the bare minimum of the project.
    • Something like: "Evaluation of water access points ..."
  • Description of the Project
    • One or two short paragraphs
    • Something like: "This Project focuses on determining ..."
  • Research Question of the Project (Optional)
    • One or two questions
  • Description of the Data
    • One short paragraph with the following information.
    • What data is included.
    • When/Where it was collected and for how long.

You can look at some examples in our published data packages:)

Thank you very much for your great collaboration! With this information we are almost ready to publish the package 🙌

@larnsce fyi.

Provide metadata for variables in okap and mwater data

Hi @mayalubecks

Thanks again for sharing your data with us. It looks really valuable and already comes in a nice and tidy structure that won't need much data wrangling. I will rename the variables (columns) slightly, but before I do that could you please provide a brief description for each variable in the okap and mwater data?

I have prepared a data dictionary as an XLSX file for you, which you can use.

Step 1

You can download the dictionary.xlsx file from the following link:

https://github.com/openwashdata/cbssuitabilityhaiti/raw/main/data-raw/dictionary.xlsx

Step 2

Open the file on your computer and fill in the column description with a brief description for each variable shown in the column variable_name. That would be one to two sentences with about 5 to 20 words. See an example here:

https://github.com/openwashdata/fsmglobal/blob/main/data-raw/dictionary.csv

Step 3

Upload the completed dictionary.xlsx file back into the data-raw folder using the same steps as in #1.

Thank you for working through this with us.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.