README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->
<!-- You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date. `devtools::build_readme()` is handy for this. -->

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

# eCHparser

<!-- badges: start -->
[![tic](https://github.com/statistikZH/eCHparser/workflows/tic/badge.svg)](https://github.com/statistikZH/eCHparser/actions)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
<!-- badges: end -->

Convert XML files containing data in the eCH-0252 standard format to easy-to-use dataframes using the eCHparser package.

## Installation

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

``` r
# install.packages("devtools")
devtools::install_github("statistikZH/eCHparser")
```

## Example: eCH-0252

The [eCH-0252 standard](https://www.ech.ch/de/ech/ech-0252/1.0.0) is used to feed voting data from cantonal IT systems to the voteInfo API, which then uses the data to display live vote counting information, for example via the voteInfo App or the [Results and Information Plattform](https://app.statistik.zh.ch/wahlen_abstimmungen/prod/Actual) of the Canton of Zurich. This data will be publicly available in this format starting in 2025. However, example files are already available in this package (see example bellow).

The function `parse_eCH_0252()` allows users to transform these XML files to easy-to-use dataframes.


```{r example, eval=FALSE}
library(eCHparser)

# list all sample files
example_files <- system.file("extdata", package = "eCHparser") |>
  list.files()

# pick a random sample file
file <- sample(seq_along(example_files), 1)

# define filepath to sample file
filepath <- system.file("extdata", testfiles[file], package = "eCHparser")

# parse file, using only federal and cantonal votes
vote_df <- parse_eCH_0252(filepath, doi = c("CH", "CT"))

```