Data publication

Introduction to our R data package workflow

This blog post provides a first step-by-step guide on how to start developing an R data package throughout openwashdata.
R
data package
github
Author
Affiliation

Margaux Götschmann

Global Health Engineering, ETH Zurich

Published

May 21, 2024

Getting started with data publication

This blog post provides a first step-by-step guide on how to start developing an R data package throughout openwashdata. Please follow the next steps carefully. If you encounter any issue, do not hesitate to reach out to us via email or by simply opening an issue on your GitHub repository and tagging us.

1. Get a GitHub account

Because you landed here, you probably have some data to share. The first step is to get familiar with GitHub since we mostly communicate via the so-called ‘GitHub issues’. Please access our GitHub organization repository at the address https://github.com/openwashdata.

➠ If you are new to GitHub, please get an account: the ‘Sign up’ button should be visible at the upper right corner of your webpage.

➠ If you already have an account, please sign in.

2. Open an issue on GitHub

The next step is to open an issue for your data so that we can communicate there directly and keep track of the ongoing data packages:

  1. Go to https://github.com/openwashdata/data/issues.

  2. Click on the green button at the upper right corner of the page named ‘New issue’.

  1. Add a title and a short description about your dataset and tag one of us @mianzg @margauxgo @larnsce before submitting the new issue.

  2. You can think about a name for your data package and add it to the issue. The name should: 

    1. have all small letters,
    2. have no spaces or dashes,
    3. be a combination of two to three words and
    4. identify location and/or theme/topic.