ds4owdanalytics

Dark data from the DS4OWD course

https://github.com/openwashdata/ds4owdanalytics

Repository

Dark data from the DS4OWD course

README.Rmd

---
output: github_document
always_allow_html: true
editor_options: 
  markdown: 
    wrap: 72
  chunk_output_type: console
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%",
  message = FALSE,
  warning = FALSE,
  fig.retina = 2,
  fig.align = 'center'
)
```

# ds4owdanalytics



[![License: CC BY
4.0](https://img.shields.io/badge/License-CC_BY_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)
[![R-CMD-check](https://github.com/openwashdata/ds4owdanalytics/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/openwashdata/ds4owdanalytics/actions/workflows/R-CMD-check.yaml)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14778963.svg)](https://zenodo.org/doi/10.5281/zenodo.14778963)



The goal of ds4owdanalytics is to make dark data from the DS4OWD course publicly available

## Installation

You can install the development version of ds4owdanalytics from
[GitHub](https://github.com/) with:

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

```{r}
## Run the following code in console if you don't have the packages
## install.packages(c("dplyr", "knitr", "readr", "stringr", "gt", "kableExtra"))
library(dplyr)
library(knitr)
library(readr)
library(stringr)
library(gt)
library(kableExtra)
```

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

1.  Click Download CSV. A window opens that displays the CSV in
    your browser.
2.  Right-click anywhere inside the window and select "Save Page As...".
3.  Save the file in a folder of your choice.

```{r, echo=FALSE, message=FALSE, warning=FALSE}

extdata_path <- "https://github.com/openwashdata/ds4owdanalytics/raw/main/inst/extdata/"

read_csv("data-raw/dictionary.csv") |> 
  distinct(file_name) |> 
  dplyr::mutate(file_name = str_remove(file_name, ".rda")) |> 
  dplyr::rename(dataset = file_name) |> 
  mutate(
    CSV = paste0("[Download CSV](", extdata_path, dataset, ".csv)"),
    XLSX = paste0("[Download XLSX](", extdata_path, dataset, ".xlsx)")
  ) |> 
  knitr::kable()

```

## Data

The package provides access to multiple datasets. These are documented in the reference guide.

```{r}
library(ds4owdanalytics)
```

### course_participation

The dataset `course_participation` contains anonymized data about participation in the online session for the DS4OWD course It has
`r nrow(course_participation)` observations and `r ncol(course_participation)`
variables

```{r}
course_participation |> 
  head(3) |> 
  gt::gt() |>
  gt::as_raw_html()
```

For an overview of the variable names, see the following table.

```{r echo=FALSE, message=FALSE, warning=FALSE}
readr::read_csv("data-raw/dictionary.csv") |>
  dplyr::filter(file_name == "course_participation.rda") |>
  dplyr::select(variable_name:description) |> 
  knitr::kable() |> 
  kableExtra::kable_styling("striped") |> 
  kableExtra::scroll_box(height = "200px")
```

## Example

Examples can be found as a dashboard published at https://openwashdata.github.io/dashboard/dashboard.html

## License

Data are available as
[CC-BY](https://github.com/openwashdata/%7B%7B%7Bpackagename%7D%7D%7D/blob/main/LICENSE.md).

## Citation

Please cite this package using:

```{r}
citation("ds4owdanalytics")
```

Owner

Citation (CITATION.cff)

# --------------------------------------------
# CITATION file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# --------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "ds4owdanalytics" in publications use:'
type: software
license: CC-BY-4.0
title: 'ds4owdanalytics: DS4OWD Analytics'
version: 0.1.0
doi: 10.5281/zenodo.14778963
abstract: Data collected from the Data Science for Open WASH Data (DS4OWD) course
  and the associated website and data publishing endeavour.
authors:
- family-names: Dubey
  given-names: Yash
  email: ydubey@ethz.ch
  orcid: https://orcid.org/0009-0001-2849-970X
repository-code: https://github.com/openwashdata/ds4owdanalytics
url: https://github.com/openwashdata/ds4owdanalytics
date-released: '2025-01-31'
contact:
- family-names: Dubey
  given-names: Yash
  email: ydubey@ethz.ch
  orcid: https://orcid.org/0009-0001-2849-970X

GitHub Events