feltr

A R package to read Felt maps to simple feature data 🗺️

https://github.com/elipousson/feltr

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
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (20.6%) to scientific vocabulary

Keywords

felt r-package rspatial rstats

Last synced: 6 months ago · JSON representation

Repository

A R package to read Felt maps to simple feature data 🗺️

Basic Info

Host: GitHub
Owner: elipousson
License: other
Language: R
Default Branch: main
Homepage: https://elipousson.github.io/feltr/
Size: 2.48 MB

Statistics

Stars: 10
Watchers: 2
Forks: 0
Open Issues: 1
Releases: 0

Topics

felt r-package rspatial rstats

Created almost 3 years ago · Last pushed about 1 year ago

Metadata Files

Readme Changelog License Codemeta

README.Rmd

---
output: github_document
---



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

# feltr 


[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Codecov test coverage](https://codecov.io/gh/elipousson/feltr/branch/main/graph/badge.svg)](https://app.codecov.io/gh/elipousson/feltr?branch=main)


The goal of feltr is to read maps from Felt as simple feature or `SpatRaster` objects.

:::{.callout-note collapse=false appearance='default' icon=true}
## Package does not support the Felt API v2

This package does not support the Felt API and, as of December 2024, I have no specific timeline for when the package will be updated to restore functionality. Please use [the feltr package](https://christophertkenny.com/feltr/index.html) (identical name but a different developer) for API access or follow [this GitHub issue for updates](https://github.com/elipousson/feltr/issues/2).
:::

## Installation

You can install the development version of feltr like so:

``` r
pak::pkg_install("elipousson/feltr")
```

## Example

```{r example}
library(feltr)
```

You can use `read_felt_map()` to create an sf object with features from a map URL.

```{r read, eval=FALSE}

url <- "https://felt.com/map/Site-Plan-Example-PGTipS2mT8CYBIVlyAm9BkD"

site_plan <- read_felt_map(url)

plot(site_plan)
```

`get_felt_map()` returns a list with basic information about a map (set `read = TRUE` to read map elements and layers at the same time):

```{r, eval=FALSE}
get_felt_map(url)
```

You can also use `read_felt_raster()` (a wrapper for `rasterpic::rasterpic_img()`) to create a `SpatRaster` object from a "Image" type feature in Felt.

```{r, eval=FALSE}
image_map <- read_felt_raster(
  "https://felt.com/map/feltr-sample-map-read-felt-raster-oiinodTbT79BEueYdGp1aND",
  "https://tile.loc.gov/image-services/iiif/service:gmd:gmd370:g3700:g3700:ct003955/full/pct:12.5/0/default.jpg"
)

image_map
```

For more information on the Felt Public API check out the guide to [Getting Started with the Felt API](https://developers.felt.com/rest-api/getting-started) or the [Felt API reference](https://developers.felt.com/rest-api/api-reference).

Note, in July 2024, Felt [announced the pricing for subscription plans](https://felt.com/blog/introducing-pricing) that are expected to limit API access to paid accounts starting in January 2024. Educators can also apply for free accounts to retain API access after January 2024.

## Related Projects

- [{feltr}](https://christophertkenny.com/feltr/): A R package with the same name that provide very similar functionality to this package.
- [felt-upload](https://pypi.org/project/felt-upload/): A Python package to upload data to Felt.
- [Add to Felt QGIS Plugin](https://plugins.qgis.org/plugins/felt/): A QGIS plugin for uploading data to Felt.
- [feltpy](https://github.com/moss-xyz/feltpy): A lightweight Python package to interact with the public API of Felt.com.

Owner

Name: Eli Pousson
Login: elipousson
Kind: user
Location: Baltimore, MD
Company: Baltimore City Department of Planning

Website: https://elipousson.github.io/
Twitter: elipousson
Repositories: 95
Profile: https://github.com/elipousson

I love old buildings and bicycles. Planner with the Baltimore City Department of Planning. Former preservationist @baltimoreheritage

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "feltr",
  "description": "Read Felt maps to simple feature objects in R.",
  "name": "feltr: Read Spatial Data from Felt",
  "relatedLink": "https://elipousson.github.io/feltr/",
  "codeRepository": "https://github.com/elipousson/feltr/",
  "issueTracker": "https://github.com/elipousson/feltr/issues",
  "license": "https://spdx.org/licenses/MIT",
  "version": "0.1.1.9005",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.3.0 (2023-04-21)",
  "provider": {
    "@id": "https://cran.r-project.org",
    "@type": "Organization",
    "name": "Comprehensive R Archive Network (CRAN)",
    "url": "https://cran.r-project.org"
  },
  "author": [
    {
      "@type": "Person",
      "givenName": "Eli",
      "familyName": "Pousson",
      "email": "eli.pousson@gmail.com",
      "@id": "https://orcid.org/0000-0001-8280-1706"
    }
  ],
  "copyrightHolder": [
    {
      "@type": "Person",
      "givenName": "Eli",
      "familyName": "Pousson",
      "email": "eli.pousson@gmail.com",
      "@id": "https://orcid.org/0000-0001-8280-1706"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Eli",
      "familyName": "Pousson",
      "email": "eli.pousson@gmail.com",
      "@id": "https://orcid.org/0000-0001-8280-1706"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "covr",
      "name": "covr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=covr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "httptest2",
      "name": "httptest2",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=httptest2"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rasterpic",
      "name": "rasterpic",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rasterpic"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "RcppSimdJson",
      "name": "RcppSimdJson",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=RcppSimdJson"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "version": ">= 3.0.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "xml2",
      "name": "xml2",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=xml2"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "cli",
      "name": "cli",
      "version": ">= 2.5.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=cli"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "grDevices",
      "name": "grDevices"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "httr2",
      "name": "httr2",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=httr2"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "lifecycle",
      "name": "lifecycle",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=lifecycle"
    },
    "5": {
      "@type": "SoftwareApplication",
      "identifier": "rlang",
      "name": "rlang",
      "version": ">= 1.1.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rlang"
    },
    "6": {
      "@type": "SoftwareApplication",
      "identifier": "sf",
      "name": "sf",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=sf"
    },
    "7": {
      "@type": "SoftwareApplication",
      "identifier": "vctrs",
      "name": "vctrs",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=vctrs"
    },
    "8": {
      "@type": "SoftwareApplication",
      "identifier": "R",
      "name": "R",
      "version": ">= 2.10"
    },
    "SystemRequirements": null
  },
  "fileSize": "393.19KB",
  "releaseNotes": "https://github.com/elipousson/feltr/blob/master/NEWS.md",
  "readme": "https://github.com/elipousson/feltr/blob/main/README.md",
  "contIntegration": "https://app.codecov.io/gh/elipousson/feltr?branch=main",
  "developmentStatus": "https://lifecycle.r-lib.org/articles/stages.html#experimental",
  "keywords": [
    "r-package",
    "rspatial",
    "rstats",
    "felt"
  ]
}

GitHub Events

Total

Watch event: 2
Push event: 2

Last Year

Watch event: 2
Push event: 2

Committers

Last synced: about 2 years ago

All Time

Total Commits: 55
Total Committers: 1
Avg Commits per committer: 55.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 55
Committers: 1
Avg Commits per committer: 55.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
Eli Pousson	e**n@g**m	55

Issues and Pull Requests

Last synced: 9 months ago

All Time

Total issues: 2
Total pull requests: 0
Average time to close issues: 10 minutes
Average time to close pull requests: N/A
Total issue authors: 2
Total pull request authors: 0
Average comments per issue: 0.5
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 1
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 1
Pull request authors: 0
Average comments per issue: 0.0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

MingScott (1)
elipousson (1)

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Dependencies

.github/workflows/pkgdown.yaml actions

JamesIves/github-pages-deploy-action v4.4.1 composite
actions/checkout v3 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

.github/workflows/test-coverage.yaml actions

actions/checkout v3 composite
actions/upload-artifact v3 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

DESCRIPTION cran

R >= 2.10 depends
cli >= 2.5.0 imports
grDevices * imports
httr2 * imports
lifecycle * imports
rlang >= 1.1.0 imports
sf * imports
vctrs * imports
RcppSimdJson * suggests
covr * suggests
httptest2 * suggests
rasterpic * suggests
testthat >= 3.0.0 suggests
xml2 * suggests

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

feltr

Science Score: 26.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.Rmd

Owner

CodeMeta (codemeta.json)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Dependencies