read_osm documentation reports wrong return class
Open
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 43
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
Code returns a stars object:
> osm_NLD <- read_osm(NLD_muni, ext=1.1)
old-style crs object detected; please recreate object with a recent sf::st_crs()
old-style crs object detected; please recreate object with a recent sf::st_crs()
> class(osm_NLD)
[1] "stars"
But doc says raster object:
Value:
The output of ‘read_osm’ is a ‘raster’ object.
There's also a few references to passing raster=FALSE and "a RasterStack is returned" - I think the docs need a refresh!
> packageDescription("tmaptools")
Package: tmaptools
Type: Package
Title: Thematic Map Tools
Version: 3.1-1
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by searching the read_osm documentation and its references to raster=FALSE and RasterStack. Compare those statements with the reported read_osm result, a stars object, and update the documentation so the return type and related usage are accurate. Done means the outdated raster wording and references are refreshed consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100