openwashdata / cbssuitabilityhaiti

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)

openwashdata

The goal of openwashdata is to …

Installation

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

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

Example

This is a basic example which shows you how to solve a common problem:

library(openwashdata)
## basic example code

cbssuitabilityhaiti's Issues

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

• Open the repository for your data: https://github.com/openwashdata/cbssuitabilityhaiti

Step 2

• Open the data-raw folder

Step 3

• Click on "Add file -> Upload files"

Step 4

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

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:)

• durbanplasticwaste: Durban (South Africa) plastic waste data
• wasteskipsblantyre: Locations of Public Waste Skips in Blantyre, Malawi
• or from the okap description from this package

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.

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!