README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->
[![R-CMD-check](https://github.com/SwissStatsR/dcatapchr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/SwissStatsR/dcatapchr/actions/workflows/R-CMD-check.yaml)
[![:name status badge](https://swissstatsr.r-universe.dev/badges/:name)](https://swissstatsr.r-universe.dev/)
[![dcatapchr status badge](https://swissstatsr.r-universe.dev/badges/dcatapchr)](https://swissstatsr.r-universe.dev/dcatapchr)


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

# dcatapchr


The goal of dcatapchr is to create a metadata catalog compatible with the 
DCAT-AP CH standard.  

Basically, a catalog consists of one or more datasets, and each dataset has one or more distributions (see https://www.dcat-ap.ch/releases/2.0/dcat-ap-ch.html and https://handbook.opendata.swiss/de/content/glossar/bibliothek/dcat-ap-ch.html).




## Installation

You can install the development version of dcatapchr like so:

``` r
remotes::install_github("SwissStatsR/dcatapchr")
```

Or from the `swissstatsr.r-universe.dev`:
```r
install.packages("dcatapchr", repos = "https://swissstatsr.r-universe.dev")
```

## Example

In the example below, a catalog is created with a dataset with 3 distributions.

```{r example}
library(dcatapchr)

# Create the metadata of a dataset with 3 distributions

# First create the 3 distributions
distributions <- c(
  dcat_distribution(
    issued = dct_issued("2021-10-14"), 
    access_url = dcat_accessURL(
      "https://www3.ti.ch/DFE/DR/USTAT/allegati/cubo/cubi_POL_01_xlsx.zip"
    ), 
    license = dct_license2(
      "NonCommercialAllowed-CommercialAllowed-ReferenceRequired"
    )
  ),
  
  dcat_distribution(
    issued = dct_issued("2021-10-14"), 
    access_url = dcat_accessURL(
      "https://www3.ti.ch/DFE/DR/USTAT/allegati/cubo/cubi_POL_01_px.zip"
    ), 
    license = dct_license2(
      "NonCommercialAllowed-CommercialAllowed-ReferenceRequired"
    )
  ),
  
  dcat_distribution(
    issued = dct_issued("2021-10-14"), 
    access_url = dcat_accessURL(
      "https://www3.ti.ch/DFE/DR/USTAT/allegati/cubo/cubi_POL_01_csv.zip"
    ), 
    licence = dct_license2(
      "NonCommercialAllowed-CommercialAllowed-ReferenceRequired"
    )
  )
)

distributions

# Then create the dataset with the 3 distributions created above
description <- readLines(
  system.file(
    "cubi_POL_01_INFORMAZIONI.txt", package = "dcatapchr"
  ), encoding = "UTF-8"
)
description <- strwrap(description, width = 80)
description <- paste(description, collapse = "\n")

# Substitute & with &amp; in urls
description <- gsub("&", "&amp;", description, fixed = TRUE)

dataset <- dcat_dataset(
  title = dct_title(
    title = "Partecipazione alle elezioni del Consiglio di Stato, per comune, in Ticino, dal 1921 al 2011", 
    language = "it"
  ), 
  description = dct_description(
    description = description, 
    language = "it"
  ), 
  publisher = dct_publisher(publisher = "https://www.ti.ch/ustat", foaf_name = "Ustat"), 
  contactPoint = dcat_contactPoint(), 
  identifier = dct_identifier(),
  distribution = distributions
)

# dataset

# And finally put the dataset in a catalog
catalog <- dcat_catalog(
  catalog_endpoint = "https://www3.ti.ch/DFE/DR/USTAT/allegati/digitale/catalogo_ustat.rdf", 
  datasets = dataset
)

head(catalog, n = 15)


tail(catalog, n = 20)
```

Export to an rdf file (with UNIX line endings):
```{r eval=FALSE}
# f <- file("./catalogo_ustat.rdf", "wb")
# writeLines(catalog, con = f, useBytes = TRUE)
# close(f)
write_unix(catalog, filename = "catalogo_ustat.rdf")
```