Conversation
asinghvi17
reviewed
Jun 10, 2026
Comment on lines
+1
to
+23
| """ | ||
| GeoDataFrames | ||
|
|
||
| Work with geospatial vector data (points, lines, polygons and their attributes) | ||
| using the familiar `DataFrame` from [DataFrames.jl](https://dataframes.juliadata.org/). | ||
|
|
||
| A GeoDataFrame is just a regular `DataFrame` with one or more columns of | ||
| [GeoInterface.jl](https://juliageo.org/GeoInterface.jl/) compatible geometries; | ||
| there is no dedicated type. The package provides: | ||
|
|
||
| - [`read`](@ref) and [`write`](@ref) for the most common vector file formats | ||
| (GeoPackage, Shapefile, GeoJSON, FlatGeobuf, GeoParquet, Arrow, ...). | ||
| - Coordinate reference system helpers such as [`setcrs!`](@ref), | ||
| [`reproject`](@ref) and [`reproject!`](@ref). | ||
| - Re-exports of `DataFrames`, `GeoInterface`, `GeometryOps` and `Extents` so that | ||
| `using GeoDataFrames` is usually all you need. | ||
|
|
||
| ```julia | ||
| using GeoDataFrames | ||
| df = DataFrame(geometry = GeoInterface.Point.(rand(10), rand(10)), name = "test") | ||
| GeoDataFrames.write("points.gpkg", df) | ||
| ``` | ||
| """ |
Collaborator
There was a problem hiding this comment.
Shouldn't this just be the readme? Harder to maintain docstrings in two places
Owner
Author
There was a problem hiding this comment.
Hmm, you mean, copy that content, or do you want to do it automagically?
Collaborator
There was a problem hiding this comment.
IIRC Julia already does it automatically, try ?GeometryOps
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.