Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/cityriverspaces/crispdataset

Material for the City River Spaces (CRiSp) dataset

https://github.com/cityriverspaces/crispdataset

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (10.3%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Material for the City River Spaces (CRiSp) dataset

Basic Info
  • Host: GitHub
  • Owner: CityRiverSpaces
  • License: apache-2.0
  • Language: R
  • Default Branch: main
  • Homepage:
  • Size: 9.02 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 1
  • Releases: 0
Created about 1 year ago · Last pushed 10 months ago
Metadata Files
Readme License

README.md

CRiSp Dataset

This repository hosts material related to the creation of the City River Spaces (CRiSp) dataset.

Setup

Local install

R should be installed (see e.g. instructions on CRAN).

It is recommended to install the required dependencies in a project environment, which can be set up using renv. In the R terminal:

```r

install.packages("renv")

renv::init(bare = TRUE) ```

When prompted for which files to use for dependency discovery, you can select 1 (DESCRIPTION file only). Restart the R terminal. It is then easiest to install the project dependencies using devtools:

r install.packages("devtools") devtools::install_deps()

Docker

We also provide a Docker image that includes all the required dependencies. The image is published on the GitHub Container Registry (GHCR), see the image page.

In order to start a container from the repository image:

  • Docker should be installed and running.

  • In a terminal window, run the following command to pull the image from the registry:

shell docker pull ghcr.io/cityriverspaces/crispdataset:latest

  • Start an interactive R session within the container with:

shell docker run --rm -it ghcr.io/cityriverspaces/crispdataset:latest

NOTE: the --rm option removes the container when terminated, the -i and -t options enable the interactive session.

Apptainer

The published Docker image can also be used with Apptainer (e.g. on DelftBlue):

  • Pull the image from GHCR and convert it to SIF format:

shell apptainer pull crispdataset.sif docker://ghcr.io/cityriverspaces/crispdataset:latest

  • Start an interactive R session within the (Apptainer) container with:

shell apptainer run crispdataset.sif

Owner

  • Name: CRiSp
  • Login: CityRiverSpaces
  • Kind: organization

City River Spaces

GitHub Events

Total
  • Issues event: 1
  • Push event: 17
  • Create event: 2
Last Year
  • Issues event: 1
  • Push event: 17
  • Create event: 2