diff --git a/previews/PR102/404.html b/previews/PR102/404.html index 64798b9..bc0404d 100644 --- a/previews/PR102/404.html +++ b/previews/PR102/404.html @@ -19,7 +19,7 @@
- + \ No newline at end of file diff --git a/previews/PR102/assets/background_formats.md.BT8Xi6kj.js b/previews/PR102/assets/background_formats.md.VC-6FvcN.js similarity index 94% rename from previews/PR102/assets/background_formats.md.BT8Xi6kj.js rename to previews/PR102/assets/background_formats.md.VC-6FvcN.js index a477ad5..8df378b 100644 --- a/previews/PR102/assets/background_formats.md.BT8Xi6kj.js +++ b/previews/PR102/assets/background_formats.md.VC-6FvcN.js @@ -1,5 +1,5 @@ import{_ as i,c as a,a5 as t,o as e}from"./chunks/framework.GA0GCIXy.js";const g=JSON.parse('{"title":"File formats","description":"","frontmatter":{},"headers":[],"relativePath":"background/formats.md","filePath":"background/formats.md","lastUpdated":null}'),l={name:"background/formats.md"};function n(h,s,p,r,d,k){return e(),a("div",null,s[0]||(s[0]=[t(`

File formats

We currently support the following file formats directly based on the file extension:

ExtensionDriver
.shpESRI Shapefile
.gpkgGPKG
.geojsonGeoJSON
.vrtVRT
.sqliteSQLite
.csvCSV
.fgbFlatGeobuf
.pqParquet
.arrowArrow
.gmlGML
.ncnetCDF

If you get an error like so:

julia
GeoDataFrames.write("test.foo", df)
-ERROR: ArgumentError: There are no GDAL drivers for the .foo extension

You can specifiy the driver using a keyword as follows:

julia
GeoDataFrames.write("test.foo", df; driver="GeoJSON")

The complete list of driver codes are listed in the GDAL documentation.

Package extensions

For several file formats, there now exist native Julia packages that can be used as backends. Before using such a specific file format, you must install and load its corresponding package.

julia
using Pkg
+ERROR: ArgumentError: There are no GDAL drivers for the .foo extension

You can specifiy the driver using a keyword as follows:

julia
GeoDataFrames.write("test.foo", df; driver="GeoJSON")

The complete list of driver codes are listed in the GDAL documentation.

Package extensions

For several file formats, there now exist native Julia packages that can be used as backends. Before using such a specific file format, you must install and load its corresponding package.

julia
using Pkg
 Pkg.add("GeoJSON")
julia
using Pkg
 Pkg.add("GeoArrow")
julia
using Pkg
 Pkg.add("GeoParquet")
julia
using Pkg
diff --git a/previews/PR102/assets/background_formats.md.BT8Xi6kj.lean.js b/previews/PR102/assets/background_formats.md.VC-6FvcN.lean.js
similarity index 94%
rename from previews/PR102/assets/background_formats.md.BT8Xi6kj.lean.js
rename to previews/PR102/assets/background_formats.md.VC-6FvcN.lean.js
index a477ad5..8df378b 100644
--- a/previews/PR102/assets/background_formats.md.BT8Xi6kj.lean.js
+++ b/previews/PR102/assets/background_formats.md.VC-6FvcN.lean.js
@@ -1,5 +1,5 @@
 import{_ as i,c as a,a5 as t,o as e}from"./chunks/framework.GA0GCIXy.js";const g=JSON.parse('{"title":"File formats","description":"","frontmatter":{},"headers":[],"relativePath":"background/formats.md","filePath":"background/formats.md","lastUpdated":null}'),l={name:"background/formats.md"};function n(h,s,p,r,d,k){return e(),a("div",null,s[0]||(s[0]=[t(`

File formats

We currently support the following file formats directly based on the file extension:

ExtensionDriver
.shpESRI Shapefile
.gpkgGPKG
.geojsonGeoJSON
.vrtVRT
.sqliteSQLite
.csvCSV
.fgbFlatGeobuf
.pqParquet
.arrowArrow
.gmlGML
.ncnetCDF

If you get an error like so:

julia
GeoDataFrames.write("test.foo", df)
-ERROR: ArgumentError: There are no GDAL drivers for the .foo extension

You can specifiy the driver using a keyword as follows:

julia
GeoDataFrames.write("test.foo", df; driver="GeoJSON")

The complete list of driver codes are listed in the GDAL documentation.

Package extensions

For several file formats, there now exist native Julia packages that can be used as backends. Before using such a specific file format, you must install and load its corresponding package.

julia
using Pkg
+ERROR: ArgumentError: There are no GDAL drivers for the .foo extension

You can specifiy the driver using a keyword as follows:

julia
GeoDataFrames.write("test.foo", df; driver="GeoJSON")

The complete list of driver codes are listed in the GDAL documentation.

Package extensions

For several file formats, there now exist native Julia packages that can be used as backends. Before using such a specific file format, you must install and load its corresponding package.

julia
using Pkg
 Pkg.add("GeoJSON")
julia
using Pkg
 Pkg.add("GeoArrow")
julia
using Pkg
 Pkg.add("GeoParquet")
julia
using Pkg
diff --git a/previews/PR102/assets/index.md.CzQB-VjH.js b/previews/PR102/assets/index.md.BIUkIgc6.js
similarity index 94%
rename from previews/PR102/assets/index.md.CzQB-VjH.js
rename to previews/PR102/assets/index.md.BIUkIgc6.js
index b520824..283f69e 100644
--- a/previews/PR102/assets/index.md.CzQB-VjH.js
+++ b/previews/PR102/assets/index.md.BIUkIgc6.js
@@ -2,7 +2,7 @@ import{_ as s,c as i,a5 as e,o as t}from"./chunks/framework.GA0GCIXy.js";const g
 julia> Pkg.add("GeoDataFrames.jl")
 # or
 julia> ] # ']' should be pressed
-pkg> add GeoDataFrames

If you want to use the latest unreleased version, you can run the following command:

julia
pkg> add GeoDataFrames#main

Package extensions

GeoDataFrames depends on GDAL to load and save data by default. However, for several file formats, there now exist native Julia packages that can be used as backends. Before using such a specific file format, you must install and load its corresponding package.

julia
using Pkg
+pkg> add GeoDataFrames

If you want to use the latest unreleased version, you can run the following command:

julia
pkg> add GeoDataFrames#main

Package extensions

GeoDataFrames depends on GDAL to load and save data by default. However, for several file formats, there now exist native Julia packages that can be used as backends. Before using such a specific file format, you must install and load its corresponding package.

julia
using Pkg
 Pkg.add("GeoJSON")
julia
using Pkg
 Pkg.add("GeoArrow")
julia
using Pkg
 Pkg.add("GeoParquet")
julia
using Pkg
diff --git a/previews/PR102/assets/index.md.CzQB-VjH.lean.js b/previews/PR102/assets/index.md.BIUkIgc6.lean.js
similarity index 94%
rename from previews/PR102/assets/index.md.CzQB-VjH.lean.js
rename to previews/PR102/assets/index.md.BIUkIgc6.lean.js
index b520824..283f69e 100644
--- a/previews/PR102/assets/index.md.CzQB-VjH.lean.js
+++ b/previews/PR102/assets/index.md.BIUkIgc6.lean.js
@@ -2,7 +2,7 @@ import{_ as s,c as i,a5 as e,o as t}from"./chunks/framework.GA0GCIXy.js";const g
 julia> Pkg.add("GeoDataFrames.jl")
 # or
 julia> ] # ']' should be pressed
-pkg> add GeoDataFrames

If you want to use the latest unreleased version, you can run the following command:

julia
pkg> add GeoDataFrames#main

Package extensions

GeoDataFrames depends on GDAL to load and save data by default. However, for several file formats, there now exist native Julia packages that can be used as backends. Before using such a specific file format, you must install and load its corresponding package.

julia
using Pkg
+pkg> add GeoDataFrames

If you want to use the latest unreleased version, you can run the following command:

julia
pkg> add GeoDataFrames#main

Package extensions

GeoDataFrames depends on GDAL to load and save data by default. However, for several file formats, there now exist native Julia packages that can be used as backends. Before using such a specific file format, you must install and load its corresponding package.

julia
using Pkg
 Pkg.add("GeoJSON")
julia
using Pkg
 Pkg.add("GeoArrow")
julia
using Pkg
 Pkg.add("GeoParquet")
julia
using Pkg
diff --git a/previews/PR102/assets/reference_api.md.Dv0ixjym.js b/previews/PR102/assets/reference_api.md.BrHa313O.js
similarity index 68%
rename from previews/PR102/assets/reference_api.md.Dv0ixjym.js
rename to previews/PR102/assets/reference_api.md.BrHa313O.js
index f852892..034353b 100644
--- a/previews/PR102/assets/reference_api.md.Dv0ixjym.js
+++ b/previews/PR102/assets/reference_api.md.BrHa313O.js
@@ -1 +1 @@
-import{_ as l,c as n,j as s,a,G as t,a5 as r,B as p,o}from"./chunks/framework.GA0GCIXy.js";const L=JSON.parse('{"title":"API","description":"","frontmatter":{},"headers":[],"relativePath":"reference/api.md","filePath":"reference/api.md","lastUpdated":null}'),h={name:"reference/api.md"},d={class:"jldocstring custom-block",open:""},k={class:"jldocstring custom-block",open:""},c={class:"jldocstring custom-block",open:""},g={class:"jldocstring custom-block",open:""},f={class:"jldocstring custom-block",open:""},u={class:"jldocstring custom-block",open:""},b={class:"jldocstring custom-block",open:""},y={class:"jldocstring custom-block",open:""},F={class:"jldocstring custom-block",open:""},m={class:"jldocstring custom-block",open:""};function D(E,e,v,j,G,C){const i=p("Badge");return o(),n("div",null,[e[36]||(e[36]=s("h1",{id:"api",tabindex:"-1"},[a("API "),s("a",{class:"header-anchor",href:"#api","aria-label":'Permalink to "API"'},"​")],-1)),s("details",d,[s("summary",null,[e[0]||(e[0]=s("a",{id:"GeoDataFrames.read",href:"#GeoDataFrames.read"},[s("span",{class:"jlbinding"},"GeoDataFrames.read")],-1)),e[1]||(e[1]=a()),t(i,{type:"info",class:"jlObjectType jlFunction",text:"Function"})]),e[2]||(e[2]=r('
julia
read(fn::AbstractString; layer::Union{Integer,AbstractString}, kwargs...)

Read a file into a DataFrame. Any kwargs are passed to the driver, by default set to ArchGDALDriver.

source

julia
read(driver::AbstractDriver, fn::AbstractString; kwargs...)

Read a file into a DataFrame using the specified driver. Any kwargs are passed to the driver, by default set to ArchGDALDriver.

source

julia
read(driver::ArchGDALDriver, fn::AbstractString; layer::Union{Integer,AbstractString}, kwargs...)

Read a file into a DataFrame using the ArchGDAL driver. By default you only get the first layer, unless you specify either the index (0 based) or name (string) of the layer. Other supported kwargs are passed to the ArchGDAL read method.

source

',9))]),s("details",k,[s("summary",null,[e[3]||(e[3]=s("a",{id:"GeoDataFrames.write",href:"#GeoDataFrames.write"},[s("span",{class:"jlbinding"},"GeoDataFrames.write")],-1)),e[4]||(e[4]=a()),t(i,{type:"info",class:"jlObjectType jlFunction",text:"Function"})]),e[5]||(e[5]=r('
julia
write(fn::AbstractString, table; kwargs...)

Write the provided table to fn. A driver is selected based on the extension of fn.

source

julia
write(driver::AbstractDriver, fn::AbstractString, table; kwargs...)

Write the provided table to fn using the specified driver. Any kwargs are passed to the driver, by default set to ArchGDALDriver.

source

julia
write(driver::ArchGDALDriver, fn::AbstractString, table; layer_name="data", crs::Union{GFT.GeoFormat,Nothing}=getcrs(table), driver::Union{Nothing,AbstractString}=nothing, options::Dict{String,String}=Dict(), geom_columns::Tuple{Symbol}=getgeometrycolumns(table), kwargs...)

Write the provided table to fn using the ArchGDAL driver.

source

',9))]),s("details",c,[s("summary",null,[e[6]||(e[6]=s("a",{id:"GeoDataFrames.reproject",href:"#GeoDataFrames.reproject"},[s("span",{class:"jlbinding"},"GeoDataFrames.reproject")],-1)),e[7]||(e[7]=a()),t(i,{type:"info",class:"jlObjectType jlFunction",text:"Function"})]),e[8]||(e[8]=r('
julia
reproject(df::DataFrame, to_crs)

Reproject the geometries in a DataFrame df to a new Coordinate Reference System to_crs, from the current CRS. See also reproject(df, from_crs, to_crs) and the in place version reproject!(df, to_crs).

source

julia
reproject(df::DataFrame, from_crs, to_crs)

Reproject the geometries in a DataFrame df from the crs from_crs to a new crs to_crs. This overrides any current CRS of the Dataframe.

source

',6))]),s("details",g,[s("summary",null,[e[9]||(e[9]=s("a",{id:"GeoDataFrames.reproject!",href:"#GeoDataFrames.reproject!"},[s("span",{class:"jlbinding"},"GeoDataFrames.reproject!")],-1)),e[10]||(e[10]=a()),t(i,{type:"info",class:"jlObjectType jlFunction",text:"Function"})]),e[11]||(e[11]=r('
julia
reproject!(df::DataFrame, to_crs)

Reproject the geometries in a DataFrame df to a new Coordinate Reference System to_crs, from the current CRS, in place.

source

julia
reproject!(df::DataFrame, from_crs, to_crs)

Reproject the geometries in a DataFrame df from the crs from_crs to a new crs to_crs in place. This overrides any current CRS of the Dataframe.

source

',6))]),e[37]||(e[37]=s("h2",{id:"drivers",tabindex:"-1"},[a("Drivers "),s("a",{class:"header-anchor",href:"#drivers","aria-label":'Permalink to "Drivers"'},"​")],-1)),e[38]||(e[38]=s("p",null,"The following drivers are provided:",-1)),s("details",f,[s("summary",null,[e[12]||(e[12]=s("a",{id:"GeoDataFrames.GeoJSONDriver",href:"#GeoDataFrames.GeoJSONDriver"},[s("span",{class:"jlbinding"},"GeoDataFrames.GeoJSONDriver")],-1)),e[13]||(e[13]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),e[14]||(e[14]=s("p",null,"GeoJSON driver",-1)),e[15]||(e[15]=s("p",null,[s("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/0935e6be0c679e562cea36df2f25cc2570cff3e1/src/drivers.jl#LL3-L5",target:"_blank",rel:"noreferrer"},"source")],-1))]),s("details",u,[s("summary",null,[e[16]||(e[16]=s("a",{id:"GeoDataFrames.ShapefileDriver",href:"#GeoDataFrames.ShapefileDriver"},[s("span",{class:"jlbinding"},"GeoDataFrames.ShapefileDriver")],-1)),e[17]||(e[17]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),e[18]||(e[18]=s("p",null,"Shapefile driver",-1)),e[19]||(e[19]=s("p",null,[s("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/0935e6be0c679e562cea36df2f25cc2570cff3e1/src/drivers.jl#LL7-L9",target:"_blank",rel:"noreferrer"},"source")],-1))]),s("details",b,[s("summary",null,[e[20]||(e[20]=s("a",{id:"GeoDataFrames.GeoParquetDriver",href:"#GeoDataFrames.GeoParquetDriver"},[s("span",{class:"jlbinding"},"GeoDataFrames.GeoParquetDriver")],-1)),e[21]||(e[21]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),e[22]||(e[22]=s("p",null,"GeoParquet driver",-1)),e[23]||(e[23]=s("p",null,[s("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/0935e6be0c679e562cea36df2f25cc2570cff3e1/src/drivers.jl#LL11-L13",target:"_blank",rel:"noreferrer"},"source")],-1))]),s("details",y,[s("summary",null,[e[24]||(e[24]=s("a",{id:"GeoDataFrames.FlatGeobufDriver",href:"#GeoDataFrames.FlatGeobufDriver"},[s("span",{class:"jlbinding"},"GeoDataFrames.FlatGeobufDriver")],-1)),e[25]||(e[25]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),e[26]||(e[26]=s("p",null,"FlatGeobuf driver",-1)),e[27]||(e[27]=s("p",null,[s("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/0935e6be0c679e562cea36df2f25cc2570cff3e1/src/drivers.jl#LL15-L17",target:"_blank",rel:"noreferrer"},"source")],-1))]),s("details",F,[s("summary",null,[e[28]||(e[28]=s("a",{id:"GeoDataFrames.ArchGDALDriver",href:"#GeoDataFrames.ArchGDALDriver"},[s("span",{class:"jlbinding"},"GeoDataFrames.ArchGDALDriver")],-1)),e[29]||(e[29]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),e[30]||(e[30]=s("p",null,"ArchGDAL driver (default)",-1)),e[31]||(e[31]=s("p",null,[s("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/0935e6be0c679e562cea36df2f25cc2570cff3e1/src/drivers.jl#LL19-L21",target:"_blank",rel:"noreferrer"},"source")],-1))]),s("details",m,[s("summary",null,[e[32]||(e[32]=s("a",{id:"GeoDataFrames.GeoArrowDriver",href:"#GeoDataFrames.GeoArrowDriver"},[s("span",{class:"jlbinding"},"GeoDataFrames.GeoArrowDriver")],-1)),e[33]||(e[33]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),e[34]||(e[34]=s("p",null,"GeoArrow driver",-1)),e[35]||(e[35]=s("p",null,[s("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/0935e6be0c679e562cea36df2f25cc2570cff3e1/src/drivers.jl#LL23-L25",target:"_blank",rel:"noreferrer"},"source")],-1))]),e[39]||(e[39]=s("p",null,[a("These can be passed to the "),s("a",{href:"/GeoDataFrames.jl/previews/PR102/reference/api#GeoDataFrames.read"},[s("code",null,"read")]),a(" and "),s("a",{href:"/GeoDataFrames.jl/previews/PR102/reference/api#GeoDataFrames.write"},[s("code",null,"write")]),a(" functions as the first argument, but require the corresponding package to be loaded. You can find the corresponding package to load in the "),s("a",{href:"/GeoDataFrames.jl/previews/PR102/reference/api#package-extensions"},"package extensions"),a(" section.")],-1))])}const B=l(h,[["render",D]]);export{L as __pageData,B as default}; +import{_ as l,c as n,j as e,a,G as t,a5 as r,B as p,o}from"./chunks/framework.GA0GCIXy.js";const L=JSON.parse('{"title":"API","description":"","frontmatter":{},"headers":[],"relativePath":"reference/api.md","filePath":"reference/api.md","lastUpdated":null}'),h={name:"reference/api.md"},d={class:"jldocstring custom-block",open:""},k={class:"jldocstring custom-block",open:""},c={class:"jldocstring custom-block",open:""},g={class:"jldocstring custom-block",open:""},b={class:"jldocstring custom-block",open:""},u={class:"jldocstring custom-block",open:""},f={class:"jldocstring custom-block",open:""},y={class:"jldocstring custom-block",open:""},F={class:"jldocstring custom-block",open:""},m={class:"jldocstring custom-block",open:""};function D(E,s,v,j,G,C){const i=p("Badge");return o(),n("div",null,[s[36]||(s[36]=e("h1",{id:"api",tabindex:"-1"},[a("API "),e("a",{class:"header-anchor",href:"#api","aria-label":'Permalink to "API"'},"​")],-1)),e("details",d,[e("summary",null,[s[0]||(s[0]=e("a",{id:"GeoDataFrames.read",href:"#GeoDataFrames.read"},[e("span",{class:"jlbinding"},"GeoDataFrames.read")],-1)),s[1]||(s[1]=a()),t(i,{type:"info",class:"jlObjectType jlFunction",text:"Function"})]),s[2]||(s[2]=r('
julia
read(fn::AbstractString; layer::Union{Integer,AbstractString}, kwargs...)

Read a file into a DataFrame. Any kwargs are passed to the driver, by default set to ArchGDALDriver.

source

julia
read(driver::AbstractDriver, fn::AbstractString; kwargs...)

Read a file into a DataFrame using the specified driver. Any kwargs are passed to the driver, by default set to ArchGDALDriver.

source

julia
read(driver::ArchGDALDriver, fn::AbstractString; layer::Union{Integer,AbstractString}, kwargs...)

Read a file into a DataFrame using the ArchGDAL driver. By default you only get the first layer, unless you specify either the index (0 based) or name (string) of the layer. Other supported kwargs are passed to the ArchGDAL read method.

source

',9))]),e("details",k,[e("summary",null,[s[3]||(s[3]=e("a",{id:"GeoDataFrames.write",href:"#GeoDataFrames.write"},[e("span",{class:"jlbinding"},"GeoDataFrames.write")],-1)),s[4]||(s[4]=a()),t(i,{type:"info",class:"jlObjectType jlFunction",text:"Function"})]),s[5]||(s[5]=r('
julia
write(fn::AbstractString, table; kwargs...)

Write the provided table to fn. A driver is selected based on the extension of fn.

source

julia
write(driver::AbstractDriver, fn::AbstractString, table; kwargs...)

Write the provided table to fn using the specified driver. Any kwargs are passed to the driver, by default set to ArchGDALDriver.

source

julia
write(driver::ArchGDALDriver, fn::AbstractString, table; layer_name="data", crs::Union{GFT.GeoFormat,Nothing}=getcrs(table), driver::Union{Nothing,AbstractString}=nothing, options::Dict{String,String}=Dict(), geom_columns::Tuple{Symbol}=getgeometrycolumns(table), kwargs...)

Write the provided table to fn using the ArchGDAL driver.

source

',9))]),e("details",c,[e("summary",null,[s[6]||(s[6]=e("a",{id:"GeoDataFrames.reproject",href:"#GeoDataFrames.reproject"},[e("span",{class:"jlbinding"},"GeoDataFrames.reproject")],-1)),s[7]||(s[7]=a()),t(i,{type:"info",class:"jlObjectType jlFunction",text:"Function"})]),s[8]||(s[8]=r('
julia
reproject(df::DataFrame, to_crs)

Reproject the geometries in a DataFrame df to a new Coordinate Reference System to_crs, from the current CRS. See also reproject(df, from_crs, to_crs) and the in place version reproject!(df, to_crs).

source

julia
reproject(df::DataFrame, from_crs, to_crs)

Reproject the geometries in a DataFrame df from the crs from_crs to a new crs to_crs. This overrides any current CRS of the Dataframe.

source

',6))]),e("details",g,[e("summary",null,[s[9]||(s[9]=e("a",{id:"GeoDataFrames.reproject!",href:"#GeoDataFrames.reproject!"},[e("span",{class:"jlbinding"},"GeoDataFrames.reproject!")],-1)),s[10]||(s[10]=a()),t(i,{type:"info",class:"jlObjectType jlFunction",text:"Function"})]),s[11]||(s[11]=r('
julia
reproject!(df::DataFrame, to_crs)

Reproject the geometries in a DataFrame df to a new Coordinate Reference System to_crs, from the current CRS, in place.

source

julia
reproject!(df::DataFrame, from_crs, to_crs)

Reproject the geometries in a DataFrame df from the crs from_crs to a new crs to_crs in place. This overrides any current CRS of the Dataframe.

source

',6))]),s[37]||(s[37]=e("h2",{id:"drivers",tabindex:"-1"},[a("Drivers "),e("a",{class:"header-anchor",href:"#drivers","aria-label":'Permalink to "Drivers"'},"​")],-1)),s[38]||(s[38]=e("p",null,"The following drivers are provided:",-1)),e("details",b,[e("summary",null,[s[12]||(s[12]=e("a",{id:"GeoDataFrames.GeoJSONDriver",href:"#GeoDataFrames.GeoJSONDriver"},[e("span",{class:"jlbinding"},"GeoDataFrames.GeoJSONDriver")],-1)),s[13]||(s[13]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),s[14]||(s[14]=e("p",null,"GeoJSON driver",-1)),s[15]||(s[15]=e("p",null,[e("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/4e5f0b104c7cc767d6ff360ae95a334b0ba72695/src/drivers.jl#LL3-L5",target:"_blank",rel:"noreferrer"},"source")],-1))]),e("details",u,[e("summary",null,[s[16]||(s[16]=e("a",{id:"GeoDataFrames.ShapefileDriver",href:"#GeoDataFrames.ShapefileDriver"},[e("span",{class:"jlbinding"},"GeoDataFrames.ShapefileDriver")],-1)),s[17]||(s[17]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),s[18]||(s[18]=e("p",null,"Shapefile driver",-1)),s[19]||(s[19]=e("p",null,[e("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/4e5f0b104c7cc767d6ff360ae95a334b0ba72695/src/drivers.jl#LL7-L9",target:"_blank",rel:"noreferrer"},"source")],-1))]),e("details",f,[e("summary",null,[s[20]||(s[20]=e("a",{id:"GeoDataFrames.GeoParquetDriver",href:"#GeoDataFrames.GeoParquetDriver"},[e("span",{class:"jlbinding"},"GeoDataFrames.GeoParquetDriver")],-1)),s[21]||(s[21]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),s[22]||(s[22]=e("p",null,"GeoParquet driver",-1)),s[23]||(s[23]=e("p",null,[e("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/4e5f0b104c7cc767d6ff360ae95a334b0ba72695/src/drivers.jl#LL11-L13",target:"_blank",rel:"noreferrer"},"source")],-1))]),e("details",y,[e("summary",null,[s[24]||(s[24]=e("a",{id:"GeoDataFrames.FlatGeobufDriver",href:"#GeoDataFrames.FlatGeobufDriver"},[e("span",{class:"jlbinding"},"GeoDataFrames.FlatGeobufDriver")],-1)),s[25]||(s[25]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),s[26]||(s[26]=e("p",null,"FlatGeobuf driver",-1)),s[27]||(s[27]=e("p",null,[e("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/4e5f0b104c7cc767d6ff360ae95a334b0ba72695/src/drivers.jl#LL15-L17",target:"_blank",rel:"noreferrer"},"source")],-1))]),e("details",F,[e("summary",null,[s[28]||(s[28]=e("a",{id:"GeoDataFrames.ArchGDALDriver",href:"#GeoDataFrames.ArchGDALDriver"},[e("span",{class:"jlbinding"},"GeoDataFrames.ArchGDALDriver")],-1)),s[29]||(s[29]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),s[30]||(s[30]=e("p",null,"ArchGDAL driver (default)",-1)),s[31]||(s[31]=e("p",null,[e("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/4e5f0b104c7cc767d6ff360ae95a334b0ba72695/src/drivers.jl#LL19-L21",target:"_blank",rel:"noreferrer"},"source")],-1))]),e("details",m,[e("summary",null,[s[32]||(s[32]=e("a",{id:"GeoDataFrames.GeoArrowDriver",href:"#GeoDataFrames.GeoArrowDriver"},[e("span",{class:"jlbinding"},"GeoDataFrames.GeoArrowDriver")],-1)),s[33]||(s[33]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),s[34]||(s[34]=e("p",null,"GeoArrow driver",-1)),s[35]||(s[35]=e("p",null,[e("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/4e5f0b104c7cc767d6ff360ae95a334b0ba72695/src/drivers.jl#LL23-L25",target:"_blank",rel:"noreferrer"},"source")],-1))]),s[39]||(s[39]=e("p",null,[a("These can be passed to the "),e("a",{href:"/GeoDataFrames.jl/previews/PR102/reference/api#GeoDataFrames.read"},[e("code",null,"read")]),a(" and "),e("a",{href:"/GeoDataFrames.jl/previews/PR102/reference/api#GeoDataFrames.write"},[e("code",null,"write")]),a(" functions as the first argument, but require the corresponding package to be loaded. You can find the corresponding package to load in the "),e("a",{href:"/GeoDataFrames.jl/previews/PR102/reference/api#package-extensions"},"package extensions"),a(" section.")],-1))])}const B=l(h,[["render",D]]);export{L as __pageData,B as default}; diff --git a/previews/PR102/assets/reference_api.md.Dv0ixjym.lean.js b/previews/PR102/assets/reference_api.md.BrHa313O.lean.js similarity index 68% rename from previews/PR102/assets/reference_api.md.Dv0ixjym.lean.js rename to previews/PR102/assets/reference_api.md.BrHa313O.lean.js index f852892..034353b 100644 --- a/previews/PR102/assets/reference_api.md.Dv0ixjym.lean.js +++ b/previews/PR102/assets/reference_api.md.BrHa313O.lean.js @@ -1 +1 @@ -import{_ as l,c as n,j as s,a,G as t,a5 as r,B as p,o}from"./chunks/framework.GA0GCIXy.js";const L=JSON.parse('{"title":"API","description":"","frontmatter":{},"headers":[],"relativePath":"reference/api.md","filePath":"reference/api.md","lastUpdated":null}'),h={name:"reference/api.md"},d={class:"jldocstring custom-block",open:""},k={class:"jldocstring custom-block",open:""},c={class:"jldocstring custom-block",open:""},g={class:"jldocstring custom-block",open:""},f={class:"jldocstring custom-block",open:""},u={class:"jldocstring custom-block",open:""},b={class:"jldocstring custom-block",open:""},y={class:"jldocstring custom-block",open:""},F={class:"jldocstring custom-block",open:""},m={class:"jldocstring custom-block",open:""};function D(E,e,v,j,G,C){const i=p("Badge");return o(),n("div",null,[e[36]||(e[36]=s("h1",{id:"api",tabindex:"-1"},[a("API "),s("a",{class:"header-anchor",href:"#api","aria-label":'Permalink to "API"'},"​")],-1)),s("details",d,[s("summary",null,[e[0]||(e[0]=s("a",{id:"GeoDataFrames.read",href:"#GeoDataFrames.read"},[s("span",{class:"jlbinding"},"GeoDataFrames.read")],-1)),e[1]||(e[1]=a()),t(i,{type:"info",class:"jlObjectType jlFunction",text:"Function"})]),e[2]||(e[2]=r('
julia
read(fn::AbstractString; layer::Union{Integer,AbstractString}, kwargs...)

Read a file into a DataFrame. Any kwargs are passed to the driver, by default set to ArchGDALDriver.

source

julia
read(driver::AbstractDriver, fn::AbstractString; kwargs...)

Read a file into a DataFrame using the specified driver. Any kwargs are passed to the driver, by default set to ArchGDALDriver.

source

julia
read(driver::ArchGDALDriver, fn::AbstractString; layer::Union{Integer,AbstractString}, kwargs...)

Read a file into a DataFrame using the ArchGDAL driver. By default you only get the first layer, unless you specify either the index (0 based) or name (string) of the layer. Other supported kwargs are passed to the ArchGDAL read method.

source

',9))]),s("details",k,[s("summary",null,[e[3]||(e[3]=s("a",{id:"GeoDataFrames.write",href:"#GeoDataFrames.write"},[s("span",{class:"jlbinding"},"GeoDataFrames.write")],-1)),e[4]||(e[4]=a()),t(i,{type:"info",class:"jlObjectType jlFunction",text:"Function"})]),e[5]||(e[5]=r('
julia
write(fn::AbstractString, table; kwargs...)

Write the provided table to fn. A driver is selected based on the extension of fn.

source

julia
write(driver::AbstractDriver, fn::AbstractString, table; kwargs...)

Write the provided table to fn using the specified driver. Any kwargs are passed to the driver, by default set to ArchGDALDriver.

source

julia
write(driver::ArchGDALDriver, fn::AbstractString, table; layer_name="data", crs::Union{GFT.GeoFormat,Nothing}=getcrs(table), driver::Union{Nothing,AbstractString}=nothing, options::Dict{String,String}=Dict(), geom_columns::Tuple{Symbol}=getgeometrycolumns(table), kwargs...)

Write the provided table to fn using the ArchGDAL driver.

source

',9))]),s("details",c,[s("summary",null,[e[6]||(e[6]=s("a",{id:"GeoDataFrames.reproject",href:"#GeoDataFrames.reproject"},[s("span",{class:"jlbinding"},"GeoDataFrames.reproject")],-1)),e[7]||(e[7]=a()),t(i,{type:"info",class:"jlObjectType jlFunction",text:"Function"})]),e[8]||(e[8]=r('
julia
reproject(df::DataFrame, to_crs)

Reproject the geometries in a DataFrame df to a new Coordinate Reference System to_crs, from the current CRS. See also reproject(df, from_crs, to_crs) and the in place version reproject!(df, to_crs).

source

julia
reproject(df::DataFrame, from_crs, to_crs)

Reproject the geometries in a DataFrame df from the crs from_crs to a new crs to_crs. This overrides any current CRS of the Dataframe.

source

',6))]),s("details",g,[s("summary",null,[e[9]||(e[9]=s("a",{id:"GeoDataFrames.reproject!",href:"#GeoDataFrames.reproject!"},[s("span",{class:"jlbinding"},"GeoDataFrames.reproject!")],-1)),e[10]||(e[10]=a()),t(i,{type:"info",class:"jlObjectType jlFunction",text:"Function"})]),e[11]||(e[11]=r('
julia
reproject!(df::DataFrame, to_crs)

Reproject the geometries in a DataFrame df to a new Coordinate Reference System to_crs, from the current CRS, in place.

source

julia
reproject!(df::DataFrame, from_crs, to_crs)

Reproject the geometries in a DataFrame df from the crs from_crs to a new crs to_crs in place. This overrides any current CRS of the Dataframe.

source

',6))]),e[37]||(e[37]=s("h2",{id:"drivers",tabindex:"-1"},[a("Drivers "),s("a",{class:"header-anchor",href:"#drivers","aria-label":'Permalink to "Drivers"'},"​")],-1)),e[38]||(e[38]=s("p",null,"The following drivers are provided:",-1)),s("details",f,[s("summary",null,[e[12]||(e[12]=s("a",{id:"GeoDataFrames.GeoJSONDriver",href:"#GeoDataFrames.GeoJSONDriver"},[s("span",{class:"jlbinding"},"GeoDataFrames.GeoJSONDriver")],-1)),e[13]||(e[13]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),e[14]||(e[14]=s("p",null,"GeoJSON driver",-1)),e[15]||(e[15]=s("p",null,[s("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/0935e6be0c679e562cea36df2f25cc2570cff3e1/src/drivers.jl#LL3-L5",target:"_blank",rel:"noreferrer"},"source")],-1))]),s("details",u,[s("summary",null,[e[16]||(e[16]=s("a",{id:"GeoDataFrames.ShapefileDriver",href:"#GeoDataFrames.ShapefileDriver"},[s("span",{class:"jlbinding"},"GeoDataFrames.ShapefileDriver")],-1)),e[17]||(e[17]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),e[18]||(e[18]=s("p",null,"Shapefile driver",-1)),e[19]||(e[19]=s("p",null,[s("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/0935e6be0c679e562cea36df2f25cc2570cff3e1/src/drivers.jl#LL7-L9",target:"_blank",rel:"noreferrer"},"source")],-1))]),s("details",b,[s("summary",null,[e[20]||(e[20]=s("a",{id:"GeoDataFrames.GeoParquetDriver",href:"#GeoDataFrames.GeoParquetDriver"},[s("span",{class:"jlbinding"},"GeoDataFrames.GeoParquetDriver")],-1)),e[21]||(e[21]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),e[22]||(e[22]=s("p",null,"GeoParquet driver",-1)),e[23]||(e[23]=s("p",null,[s("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/0935e6be0c679e562cea36df2f25cc2570cff3e1/src/drivers.jl#LL11-L13",target:"_blank",rel:"noreferrer"},"source")],-1))]),s("details",y,[s("summary",null,[e[24]||(e[24]=s("a",{id:"GeoDataFrames.FlatGeobufDriver",href:"#GeoDataFrames.FlatGeobufDriver"},[s("span",{class:"jlbinding"},"GeoDataFrames.FlatGeobufDriver")],-1)),e[25]||(e[25]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),e[26]||(e[26]=s("p",null,"FlatGeobuf driver",-1)),e[27]||(e[27]=s("p",null,[s("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/0935e6be0c679e562cea36df2f25cc2570cff3e1/src/drivers.jl#LL15-L17",target:"_blank",rel:"noreferrer"},"source")],-1))]),s("details",F,[s("summary",null,[e[28]||(e[28]=s("a",{id:"GeoDataFrames.ArchGDALDriver",href:"#GeoDataFrames.ArchGDALDriver"},[s("span",{class:"jlbinding"},"GeoDataFrames.ArchGDALDriver")],-1)),e[29]||(e[29]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),e[30]||(e[30]=s("p",null,"ArchGDAL driver (default)",-1)),e[31]||(e[31]=s("p",null,[s("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/0935e6be0c679e562cea36df2f25cc2570cff3e1/src/drivers.jl#LL19-L21",target:"_blank",rel:"noreferrer"},"source")],-1))]),s("details",m,[s("summary",null,[e[32]||(e[32]=s("a",{id:"GeoDataFrames.GeoArrowDriver",href:"#GeoDataFrames.GeoArrowDriver"},[s("span",{class:"jlbinding"},"GeoDataFrames.GeoArrowDriver")],-1)),e[33]||(e[33]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),e[34]||(e[34]=s("p",null,"GeoArrow driver",-1)),e[35]||(e[35]=s("p",null,[s("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/0935e6be0c679e562cea36df2f25cc2570cff3e1/src/drivers.jl#LL23-L25",target:"_blank",rel:"noreferrer"},"source")],-1))]),e[39]||(e[39]=s("p",null,[a("These can be passed to the "),s("a",{href:"/GeoDataFrames.jl/previews/PR102/reference/api#GeoDataFrames.read"},[s("code",null,"read")]),a(" and "),s("a",{href:"/GeoDataFrames.jl/previews/PR102/reference/api#GeoDataFrames.write"},[s("code",null,"write")]),a(" functions as the first argument, but require the corresponding package to be loaded. You can find the corresponding package to load in the "),s("a",{href:"/GeoDataFrames.jl/previews/PR102/reference/api#package-extensions"},"package extensions"),a(" section.")],-1))])}const B=l(h,[["render",D]]);export{L as __pageData,B as default}; +import{_ as l,c as n,j as e,a,G as t,a5 as r,B as p,o}from"./chunks/framework.GA0GCIXy.js";const L=JSON.parse('{"title":"API","description":"","frontmatter":{},"headers":[],"relativePath":"reference/api.md","filePath":"reference/api.md","lastUpdated":null}'),h={name:"reference/api.md"},d={class:"jldocstring custom-block",open:""},k={class:"jldocstring custom-block",open:""},c={class:"jldocstring custom-block",open:""},g={class:"jldocstring custom-block",open:""},b={class:"jldocstring custom-block",open:""},u={class:"jldocstring custom-block",open:""},f={class:"jldocstring custom-block",open:""},y={class:"jldocstring custom-block",open:""},F={class:"jldocstring custom-block",open:""},m={class:"jldocstring custom-block",open:""};function D(E,s,v,j,G,C){const i=p("Badge");return o(),n("div",null,[s[36]||(s[36]=e("h1",{id:"api",tabindex:"-1"},[a("API "),e("a",{class:"header-anchor",href:"#api","aria-label":'Permalink to "API"'},"​")],-1)),e("details",d,[e("summary",null,[s[0]||(s[0]=e("a",{id:"GeoDataFrames.read",href:"#GeoDataFrames.read"},[e("span",{class:"jlbinding"},"GeoDataFrames.read")],-1)),s[1]||(s[1]=a()),t(i,{type:"info",class:"jlObjectType jlFunction",text:"Function"})]),s[2]||(s[2]=r('
julia
read(fn::AbstractString; layer::Union{Integer,AbstractString}, kwargs...)

Read a file into a DataFrame. Any kwargs are passed to the driver, by default set to ArchGDALDriver.

source

julia
read(driver::AbstractDriver, fn::AbstractString; kwargs...)

Read a file into a DataFrame using the specified driver. Any kwargs are passed to the driver, by default set to ArchGDALDriver.

source

julia
read(driver::ArchGDALDriver, fn::AbstractString; layer::Union{Integer,AbstractString}, kwargs...)

Read a file into a DataFrame using the ArchGDAL driver. By default you only get the first layer, unless you specify either the index (0 based) or name (string) of the layer. Other supported kwargs are passed to the ArchGDAL read method.

source

',9))]),e("details",k,[e("summary",null,[s[3]||(s[3]=e("a",{id:"GeoDataFrames.write",href:"#GeoDataFrames.write"},[e("span",{class:"jlbinding"},"GeoDataFrames.write")],-1)),s[4]||(s[4]=a()),t(i,{type:"info",class:"jlObjectType jlFunction",text:"Function"})]),s[5]||(s[5]=r('
julia
write(fn::AbstractString, table; kwargs...)

Write the provided table to fn. A driver is selected based on the extension of fn.

source

julia
write(driver::AbstractDriver, fn::AbstractString, table; kwargs...)

Write the provided table to fn using the specified driver. Any kwargs are passed to the driver, by default set to ArchGDALDriver.

source

julia
write(driver::ArchGDALDriver, fn::AbstractString, table; layer_name="data", crs::Union{GFT.GeoFormat,Nothing}=getcrs(table), driver::Union{Nothing,AbstractString}=nothing, options::Dict{String,String}=Dict(), geom_columns::Tuple{Symbol}=getgeometrycolumns(table), kwargs...)

Write the provided table to fn using the ArchGDAL driver.

source

',9))]),e("details",c,[e("summary",null,[s[6]||(s[6]=e("a",{id:"GeoDataFrames.reproject",href:"#GeoDataFrames.reproject"},[e("span",{class:"jlbinding"},"GeoDataFrames.reproject")],-1)),s[7]||(s[7]=a()),t(i,{type:"info",class:"jlObjectType jlFunction",text:"Function"})]),s[8]||(s[8]=r('
julia
reproject(df::DataFrame, to_crs)

Reproject the geometries in a DataFrame df to a new Coordinate Reference System to_crs, from the current CRS. See also reproject(df, from_crs, to_crs) and the in place version reproject!(df, to_crs).

source

julia
reproject(df::DataFrame, from_crs, to_crs)

Reproject the geometries in a DataFrame df from the crs from_crs to a new crs to_crs. This overrides any current CRS of the Dataframe.

source

',6))]),e("details",g,[e("summary",null,[s[9]||(s[9]=e("a",{id:"GeoDataFrames.reproject!",href:"#GeoDataFrames.reproject!"},[e("span",{class:"jlbinding"},"GeoDataFrames.reproject!")],-1)),s[10]||(s[10]=a()),t(i,{type:"info",class:"jlObjectType jlFunction",text:"Function"})]),s[11]||(s[11]=r('
julia
reproject!(df::DataFrame, to_crs)

Reproject the geometries in a DataFrame df to a new Coordinate Reference System to_crs, from the current CRS, in place.

source

julia
reproject!(df::DataFrame, from_crs, to_crs)

Reproject the geometries in a DataFrame df from the crs from_crs to a new crs to_crs in place. This overrides any current CRS of the Dataframe.

source

',6))]),s[37]||(s[37]=e("h2",{id:"drivers",tabindex:"-1"},[a("Drivers "),e("a",{class:"header-anchor",href:"#drivers","aria-label":'Permalink to "Drivers"'},"​")],-1)),s[38]||(s[38]=e("p",null,"The following drivers are provided:",-1)),e("details",b,[e("summary",null,[s[12]||(s[12]=e("a",{id:"GeoDataFrames.GeoJSONDriver",href:"#GeoDataFrames.GeoJSONDriver"},[e("span",{class:"jlbinding"},"GeoDataFrames.GeoJSONDriver")],-1)),s[13]||(s[13]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),s[14]||(s[14]=e("p",null,"GeoJSON driver",-1)),s[15]||(s[15]=e("p",null,[e("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/4e5f0b104c7cc767d6ff360ae95a334b0ba72695/src/drivers.jl#LL3-L5",target:"_blank",rel:"noreferrer"},"source")],-1))]),e("details",u,[e("summary",null,[s[16]||(s[16]=e("a",{id:"GeoDataFrames.ShapefileDriver",href:"#GeoDataFrames.ShapefileDriver"},[e("span",{class:"jlbinding"},"GeoDataFrames.ShapefileDriver")],-1)),s[17]||(s[17]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),s[18]||(s[18]=e("p",null,"Shapefile driver",-1)),s[19]||(s[19]=e("p",null,[e("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/4e5f0b104c7cc767d6ff360ae95a334b0ba72695/src/drivers.jl#LL7-L9",target:"_blank",rel:"noreferrer"},"source")],-1))]),e("details",f,[e("summary",null,[s[20]||(s[20]=e("a",{id:"GeoDataFrames.GeoParquetDriver",href:"#GeoDataFrames.GeoParquetDriver"},[e("span",{class:"jlbinding"},"GeoDataFrames.GeoParquetDriver")],-1)),s[21]||(s[21]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),s[22]||(s[22]=e("p",null,"GeoParquet driver",-1)),s[23]||(s[23]=e("p",null,[e("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/4e5f0b104c7cc767d6ff360ae95a334b0ba72695/src/drivers.jl#LL11-L13",target:"_blank",rel:"noreferrer"},"source")],-1))]),e("details",y,[e("summary",null,[s[24]||(s[24]=e("a",{id:"GeoDataFrames.FlatGeobufDriver",href:"#GeoDataFrames.FlatGeobufDriver"},[e("span",{class:"jlbinding"},"GeoDataFrames.FlatGeobufDriver")],-1)),s[25]||(s[25]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),s[26]||(s[26]=e("p",null,"FlatGeobuf driver",-1)),s[27]||(s[27]=e("p",null,[e("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/4e5f0b104c7cc767d6ff360ae95a334b0ba72695/src/drivers.jl#LL15-L17",target:"_blank",rel:"noreferrer"},"source")],-1))]),e("details",F,[e("summary",null,[s[28]||(s[28]=e("a",{id:"GeoDataFrames.ArchGDALDriver",href:"#GeoDataFrames.ArchGDALDriver"},[e("span",{class:"jlbinding"},"GeoDataFrames.ArchGDALDriver")],-1)),s[29]||(s[29]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),s[30]||(s[30]=e("p",null,"ArchGDAL driver (default)",-1)),s[31]||(s[31]=e("p",null,[e("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/4e5f0b104c7cc767d6ff360ae95a334b0ba72695/src/drivers.jl#LL19-L21",target:"_blank",rel:"noreferrer"},"source")],-1))]),e("details",m,[e("summary",null,[s[32]||(s[32]=e("a",{id:"GeoDataFrames.GeoArrowDriver",href:"#GeoDataFrames.GeoArrowDriver"},[e("span",{class:"jlbinding"},"GeoDataFrames.GeoArrowDriver")],-1)),s[33]||(s[33]=a()),t(i,{type:"info",class:"jlObjectType jlType",text:"Type"})]),s[34]||(s[34]=e("p",null,"GeoArrow driver",-1)),s[35]||(s[35]=e("p",null,[e("a",{href:"https://github.com/evetion/GeoDataFrames.jl/blob/4e5f0b104c7cc767d6ff360ae95a334b0ba72695/src/drivers.jl#LL23-L25",target:"_blank",rel:"noreferrer"},"source")],-1))]),s[39]||(s[39]=e("p",null,[a("These can be passed to the "),e("a",{href:"/GeoDataFrames.jl/previews/PR102/reference/api#GeoDataFrames.read"},[e("code",null,"read")]),a(" and "),e("a",{href:"/GeoDataFrames.jl/previews/PR102/reference/api#GeoDataFrames.write"},[e("code",null,"write")]),a(" functions as the first argument, but require the corresponding package to be loaded. You can find the corresponding package to load in the "),e("a",{href:"/GeoDataFrames.jl/previews/PR102/reference/api#package-extensions"},"package extensions"),a(" section.")],-1))])}const B=l(h,[["render",D]]);export{L as __pageData,B as default}; diff --git a/previews/PR102/background/formats.html b/previews/PR102/background/formats.html index bd501ce..1ee3804 100644 --- a/previews/PR102/background/formats.html +++ b/previews/PR102/background/formats.html @@ -13,7 +13,7 @@ - + @@ -22,7 +22,7 @@
Skip to content

File formats

We currently support the following file formats directly based on the file extension:

ExtensionDriver
.shpESRI Shapefile
.gpkgGPKG
.geojsonGeoJSON
.vrtVRT
.sqliteSQLite
.csvCSV
.fgbFlatGeobuf
.pqParquet
.arrowArrow
.gmlGML
.ncnetCDF

If you get an error like so:

julia
GeoDataFrames.write("test.foo", df)
-ERROR: ArgumentError: There are no GDAL drivers for the .foo extension

You can specifiy the driver using a keyword as follows:

julia
GeoDataFrames.write("test.foo", df; driver="GeoJSON")

The complete list of driver codes are listed in the GDAL documentation.

Package extensions

For several file formats, there now exist native Julia packages that can be used as backends. Before using such a specific file format, you must install and load its corresponding package.

julia
using Pkg
+ERROR: ArgumentError: There are no GDAL drivers for the .foo extension

You can specifiy the driver using a keyword as follows:

julia
GeoDataFrames.write("test.foo", df; driver="GeoJSON")

The complete list of driver codes are listed in the GDAL documentation.

Package extensions

For several file formats, there now exist native Julia packages that can be used as backends. Before using such a specific file format, you must install and load its corresponding package.

julia
using Pkg
 Pkg.add("GeoJSON")
julia
using Pkg
 Pkg.add("GeoArrow")
julia
using Pkg
 Pkg.add("GeoParquet")
julia
using Pkg
@@ -30,7 +30,7 @@
 Pkg.add("FlatGeobuf")

and as an example, to use the GeoArrow backend and download files, you will need to do:

julia
using GeoDataFrames, GeoArrow  
 # now .arrow and .feather files will be loaded using GeoArrow
 read("file.arrow")

to override this behaviour and use the default GDAL driver, you can pass the driver option as first argument:

julia
read(ArchGDALDriver(), "file.arrow")
- + \ No newline at end of file diff --git a/previews/PR102/background/geopandas.html b/previews/PR102/background/geopandas.html index e30fd2c..e988488 100644 --- a/previews/PR102/background/geopandas.html +++ b/previews/PR102/background/geopandas.html @@ -22,7 +22,7 @@
Skip to content

Inspiration

This package has been inspired by geopandas, the Python package that makes working with geospatial data formats easy. In Julia, while the same functionality is supported by ArchGDAL, reading and writing geospatial vector data is not straightforward and many questions were raised. This package wraps the required ArchGDAL operations into several oneliners.

Also see the package announcement at the Julia discourse.

- + \ No newline at end of file diff --git a/previews/PR102/background/todo.html b/previews/PR102/background/todo.html index 92018aa..3ea4a4d 100644 --- a/previews/PR102/background/todo.html +++ b/previews/PR102/background/todo.html @@ -22,7 +22,7 @@
Skip to content

Planned features

The following features are planned for future releases:

  • Prepared geometry to speed up repeated GDAL operations.

  • Spatial indice support to speed up spatial queries (see also GeoAcceleratedArrays.jl)

  • Spatial joins (see also GeometryOps.jl)

  • Wrapper types around DataFrame and geometry columns for easier plotting and dispatch.

- + \ No newline at end of file diff --git a/previews/PR102/hashmap.json b/previews/PR102/hashmap.json index 031993b..c322ead 100644 --- a/previews/PR102/hashmap.json +++ b/previews/PR102/hashmap.json @@ -1 +1 @@ -{"background_formats.md":"BT8Xi6kj","background_geopandas.md":"CAuoZMPx","background_todo.md":"DmGne6-S","index.md":"CzQB-VjH","reference_api.md":"Dv0ixjym","reference_changes.md":"BNWJP-Co","tutorials_installation.md":"DIkyOQep","tutorials_ops.md":"B_B8f-of","tutorials_usage.md":"ohbGTuwc"} +{"background_formats.md":"VC-6FvcN","background_geopandas.md":"CAuoZMPx","background_todo.md":"DmGne6-S","index.md":"BIUkIgc6","reference_api.md":"BrHa313O","reference_changes.md":"BNWJP-Co","tutorials_installation.md":"DIkyOQep","tutorials_ops.md":"B_B8f-of","tutorials_usage.md":"ohbGTuwc"} diff --git a/previews/PR102/index.html b/previews/PR102/index.html index 7b20e2b..917c444 100644 --- a/previews/PR102/index.html +++ b/previews/PR102/index.html @@ -13,7 +13,7 @@ - + @@ -25,13 +25,13 @@ julia> Pkg.add("GeoDataFrames.jl") # or julia> ] # ']' should be pressed -pkg> add GeoDataFrames

If you want to use the latest unreleased version, you can run the following command:

julia
pkg> add GeoDataFrames#main

Package extensions

GeoDataFrames depends on GDAL to load and save data by default. However, for several file formats, there now exist native Julia packages that can be used as backends. Before using such a specific file format, you must install and load its corresponding package.

julia
using Pkg
+pkg> add GeoDataFrames

If you want to use the latest unreleased version, you can run the following command:

julia
pkg> add GeoDataFrames#main

Package extensions

GeoDataFrames depends on GDAL to load and save data by default. However, for several file formats, there now exist native Julia packages that can be used as backends. Before using such a specific file format, you must install and load its corresponding package.

julia
using Pkg
 Pkg.add("GeoJSON")
julia
using Pkg
 Pkg.add("GeoArrow")
julia
using Pkg
 Pkg.add("GeoParquet")
julia
using Pkg
 Pkg.add("Shapefile")
julia
using Pkg
 Pkg.add("FlatGeobuf")

and as an example, to use the GeoArrow backend and download files, you will need to do:

julia
using GeoDataFrames, GeoArrow

🐞📌 Bugs

Bugs, errors and making issues for GeoDataFrames.jl

Because there are so many vector file types and variations of them, most of the time we need the exact file that caused your problem to know how to fix it, and be sure that we have actually fixed it when we are done. So fixing a GeoDataFrames.jl bug nearly always involves downloading some file and running some code that breaks with it (if you can trigger the bug without a file, that's great! but its not always possible).

To make an issue we can fix quickly (or at all) there are three key steps:

  1. Include the file in an accessible place on web without authentication or any other work on our part, so we can just get it and find your bug. You can put it on a file hosting platform (e.g. google drive, drop box, whatever you use) and share the url.

  2. Add a minimum working example to the issue template that first downloads the file, then runs the function that triggers the bug.

  3. Paste the complete stack trace of the error it produces, right to the bottom, into the issue template. Then we can be sure we reproduced the same problem.

Good issues are really appreciated, but they do take just a little extra effort with GeoDataFrames.jl because of this need for files.

- + \ No newline at end of file diff --git a/previews/PR102/reference/api.html b/previews/PR102/reference/api.html index 4571778..d2ae5fd 100644 --- a/previews/PR102/reference/api.html +++ b/previews/PR102/reference/api.html @@ -13,7 +13,7 @@ - + @@ -21,8 +21,8 @@ -
Skip to content

API

GeoDataFrames.read Function
julia
read(fn::AbstractString; layer::Union{Integer,AbstractString}, kwargs...)

Read a file into a DataFrame. Any kwargs are passed to the driver, by default set to ArchGDALDriver.

source

julia
read(driver::AbstractDriver, fn::AbstractString; kwargs...)

Read a file into a DataFrame using the specified driver. Any kwargs are passed to the driver, by default set to ArchGDALDriver.

source

julia
read(driver::ArchGDALDriver, fn::AbstractString; layer::Union{Integer,AbstractString}, kwargs...)

Read a file into a DataFrame using the ArchGDAL driver. By default you only get the first layer, unless you specify either the index (0 based) or name (string) of the layer. Other supported kwargs are passed to the ArchGDAL read method.

source

GeoDataFrames.write Function
julia
write(fn::AbstractString, table; kwargs...)

Write the provided table to fn. A driver is selected based on the extension of fn.

source

julia
write(driver::AbstractDriver, fn::AbstractString, table; kwargs...)

Write the provided table to fn using the specified driver. Any kwargs are passed to the driver, by default set to ArchGDALDriver.

source

julia
write(driver::ArchGDALDriver, fn::AbstractString, table; layer_name="data", crs::Union{GFT.GeoFormat,Nothing}=getcrs(table), driver::Union{Nothing,AbstractString}=nothing, options::Dict{String,String}=Dict(), geom_columns::Tuple{Symbol}=getgeometrycolumns(table), kwargs...)

Write the provided table to fn using the ArchGDAL driver.

source

GeoDataFrames.reproject Function
julia
reproject(df::DataFrame, to_crs)

Reproject the geometries in a DataFrame df to a new Coordinate Reference System to_crs, from the current CRS. See also reproject(df, from_crs, to_crs) and the in place version reproject!(df, to_crs).

source

julia
reproject(df::DataFrame, from_crs, to_crs)

Reproject the geometries in a DataFrame df from the crs from_crs to a new crs to_crs. This overrides any current CRS of the Dataframe.

source

GeoDataFrames.reproject! Function
julia
reproject!(df::DataFrame, to_crs)

Reproject the geometries in a DataFrame df to a new Coordinate Reference System to_crs, from the current CRS, in place.

source

julia
reproject!(df::DataFrame, from_crs, to_crs)

Reproject the geometries in a DataFrame df from the crs from_crs to a new crs to_crs in place. This overrides any current CRS of the Dataframe.

source

Drivers

The following drivers are provided:

GeoDataFrames.GeoJSONDriver Type

GeoJSON driver

source

GeoDataFrames.ShapefileDriver Type

Shapefile driver

source

GeoDataFrames.GeoParquetDriver Type

GeoParquet driver

source

GeoDataFrames.FlatGeobufDriver Type

FlatGeobuf driver

source

GeoDataFrames.ArchGDALDriver Type

ArchGDAL driver (default)

source

GeoDataFrames.GeoArrowDriver Type

GeoArrow driver

source

These can be passed to the read and write functions as the first argument, but require the corresponding package to be loaded. You can find the corresponding package to load in the package extensions section.

- +
Skip to content

API

GeoDataFrames.read Function
julia
read(fn::AbstractString; layer::Union{Integer,AbstractString}, kwargs...)

Read a file into a DataFrame. Any kwargs are passed to the driver, by default set to ArchGDALDriver.

source

julia
read(driver::AbstractDriver, fn::AbstractString; kwargs...)

Read a file into a DataFrame using the specified driver. Any kwargs are passed to the driver, by default set to ArchGDALDriver.

source

julia
read(driver::ArchGDALDriver, fn::AbstractString; layer::Union{Integer,AbstractString}, kwargs...)

Read a file into a DataFrame using the ArchGDAL driver. By default you only get the first layer, unless you specify either the index (0 based) or name (string) of the layer. Other supported kwargs are passed to the ArchGDAL read method.

source

GeoDataFrames.write Function
julia
write(fn::AbstractString, table; kwargs...)

Write the provided table to fn. A driver is selected based on the extension of fn.

source

julia
write(driver::AbstractDriver, fn::AbstractString, table; kwargs...)

Write the provided table to fn using the specified driver. Any kwargs are passed to the driver, by default set to ArchGDALDriver.

source

julia
write(driver::ArchGDALDriver, fn::AbstractString, table; layer_name="data", crs::Union{GFT.GeoFormat,Nothing}=getcrs(table), driver::Union{Nothing,AbstractString}=nothing, options::Dict{String,String}=Dict(), geom_columns::Tuple{Symbol}=getgeometrycolumns(table), kwargs...)

Write the provided table to fn using the ArchGDAL driver.

source

GeoDataFrames.reproject Function
julia
reproject(df::DataFrame, to_crs)

Reproject the geometries in a DataFrame df to a new Coordinate Reference System to_crs, from the current CRS. See also reproject(df, from_crs, to_crs) and the in place version reproject!(df, to_crs).

source

julia
reproject(df::DataFrame, from_crs, to_crs)

Reproject the geometries in a DataFrame df from the crs from_crs to a new crs to_crs. This overrides any current CRS of the Dataframe.

source

GeoDataFrames.reproject! Function
julia
reproject!(df::DataFrame, to_crs)

Reproject the geometries in a DataFrame df to a new Coordinate Reference System to_crs, from the current CRS, in place.

source

julia
reproject!(df::DataFrame, from_crs, to_crs)

Reproject the geometries in a DataFrame df from the crs from_crs to a new crs to_crs in place. This overrides any current CRS of the Dataframe.

source

Drivers

The following drivers are provided:

GeoDataFrames.GeoJSONDriver Type

GeoJSON driver

source

GeoDataFrames.ShapefileDriver Type

Shapefile driver

source

GeoDataFrames.GeoParquetDriver Type

GeoParquet driver

source

GeoDataFrames.FlatGeobufDriver Type

FlatGeobuf driver

source

GeoDataFrames.ArchGDALDriver Type

ArchGDAL driver (default)

source

GeoDataFrames.GeoArrowDriver Type

GeoArrow driver

source

These can be passed to the read and write functions as the first argument, but require the corresponding package to be loaded. You can find the corresponding package to load in the package extensions section.

+ \ No newline at end of file diff --git a/previews/PR102/reference/changes.html b/previews/PR102/reference/changes.html index 0b2c221..c1b6571 100644 --- a/previews/PR102/reference/changes.html +++ b/previews/PR102/reference/changes.html @@ -22,7 +22,7 @@
Skip to content

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

v0.4.0

  • Updated documentation, now using VitePress.

  • Add new driver framework to read files using native drivers.

  • Added native driver package extensions on GeoJSON, ShapeFile, GeoParquet, GeoArrow and FlatGeobuf.

  • Geometry columns are now wrapped in a GeometryVector, allowing for future improvements.

  • Now exports GeoInterface methods instead of ArchGDAL methods for geometry operation.

v0.3.11

  • Changed reproject to work on a DataFrame, correctly setting the (crs) metadata

  • Handle empty layers

  • Re-export GeoFormatTypes and Extents, making things like CRS and Extent available

  • Warn on possible geometry column instead of throwing an error.

  • Improve error message when file is not found.

v0.3.10

  • Changed DataFrame metadata style to :note, preserving crs after DataFrame operations.

v0.3.9

  • Implemented GeoInterface methods on DataFrame(Rows).

  • Implements transaction support on writing, notably improving writing performance.

v0.3.8

  • Retrieve CRS from layer, instead of dataset, preventing some nothing crs.

v0.3.7

  • Correctly write 3d geometries (which were previously flattened to 2d).

v0.3.6

  • Use GDAL to identify drivers, instead of relying only on file extension.

v0.3.5

  • Drop support for ArchGDAL 0.9.

v0.3.4

  • Use GeoInterface to convert geometries.

v0.3.3

  • Update to ArchGDAL 0.10

  • Change default geometry column name to geometry (was geom).

v0.3.2

  • Use metadata to store/retrieve CRS and geometry column information.

v0.3.1

  • Error out early on non existent files.

v0.3.0

  • Change geom_column to geom_columns, defaulting to using GeoInterface.jl.

  • Added options keyword to pass configuration to the GDAL driver.

  • Allow any GeoInterface.jl compatible geometry to be written (was only ArchGDAL geometries).

v0.2.4

  • Upgrade GeoFormatTypes to v0.4

v0.2.3

  • Update ArchGDAL compat to v0.9

v0.2.2

  • Expanded documentation

  • Free GDAL structures as soon as possible

v0.2.1

  • Don't export isempty as it clashes with other exports

  • Compatability with ArchGDAL v0.8 (adds missing support when reading 🎉)

v0.2.0

  • [breaking] Changed default CRS to nothing instead of WGS84.

  • Users can provide a GDAL driver when writing.

v0.1.6

  • Add support for (U)Int8,UInt16,UInt32 datatypes

v0.1.5

  • Compatability with ArchGDAL v0.7

v0.1.4

  • read now accepts layer keyword

  • Enables writing of missing data

v0.1.3

  • Forwards kwargs in the read function to ArchGDAL

v0.1.2

  • Changed write to have keyword arguments

v0.1.1

  • Small internal fixes

v0.1.0

  • First release 🎉
- + \ No newline at end of file diff --git a/previews/PR102/tutorials/installation.html b/previews/PR102/tutorials/installation.html index cedee82..a6ea522 100644 --- a/previews/PR102/tutorials/installation.html +++ b/previews/PR102/tutorials/installation.html @@ -26,7 +26,7 @@ # or julia> ] # ']' should be pressed pkg> add GeoDataFrames

If you want to use the latest unreleased version, you can run the following command:

julia
pkg> add GeoDataFrames#main
- + \ No newline at end of file diff --git a/previews/PR102/tutorials/ops.html b/previews/PR102/tutorials/ops.html index 5dc61c6..0cab0db 100644 --- a/previews/PR102/tutorials/ops.html +++ b/previews/PR102/tutorials/ops.html @@ -53,7 +53,7 @@ Geometry: POLYGON ((-453963.150526169 -4408927.89965336,-519 ... 336)) Geometry: POLYGON ((-498317.413693272 -4321687.31588764,-563 ... 764))

Plotting

julia
using Plots
 plot(df.geom)

- + \ No newline at end of file diff --git a/previews/PR102/tutorials/usage.html b/previews/PR102/tutorials/usage.html index 0f3ab1f..39b3f1f 100644 --- a/previews/PR102/tutorials/usage.html +++ b/previews/PR102/tutorials/usage.html @@ -53,7 +53,7 @@ ".gml" => "GML" ".nc" => "netCDF"

Note that any Tables.jl compatible table with GeoInterface.jl compatible geometries can be written by GeoDataFrames. You might want to pass which column(s) contain geometries, or by defining GeoInterface.geometrycolumns on your table. Multiple geometry columns, when enabled by the driver, can be provided in this way.

julia
table = [(; geom=AG.createpoint(1.0, 2.0), name="test")]
 GDF.write(tfn, table; geom_columns=(:geometry,),)
- + \ No newline at end of file