Skip to content

Commit

Permalink
Docs tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
rafaqz committed Dec 5, 2024
1 parent b6fabe5 commit 367181d
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 30 deletions.
25 changes: 12 additions & 13 deletions docs/src/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ export default defineConfig({
},
{ text: 'Examples',
items: [
{ text: 'Species Distribution Modelling', link: '/gbif_workflow' },
{ text: 'Species Distribution Modelling', link: '/gbif_wflow' },
]
},
{ text: 'Ecosystem',
Expand All @@ -78,20 +78,19 @@ export default defineConfig({
{ text: 'Overview', link: '/methods' },
{ text: 'Array Operations', link: '/array_operations' },
]
},
{ text: 'Data Sources',
items: [
{ text: 'Overview', link: '/data_sources' },
{ text: 'GBIF', link: '/gbif_wflow' }
]
},
{ text: 'Data Sources', link: '/data_sources' },
{ text: 'Plots',
items: [
{ text: 'Plots.jl', link: '/plotting' },
{ text: 'Makie.jl', link: '/plot_makie' },
]
},

items: [
{ text: 'Plots.jl', link: '/plotting' },
{ text: 'Makie.jl', link: '/plot_makie' },
]
},
{ text: 'Examples',
items: [
{ text: 'Species Distribution Modelling', link: '/gbif_wflow' },
]
},
{ text: 'API', link: '/api' }
],
editLink: {
Expand Down
32 changes: 15 additions & 17 deletions docs/src/methods.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
## Point, polygon and table operations

| Methods | Description |
| :------------------------ | :--------------------------------------------------------------------------- |
| [`rasterize`](@ref) | rasterize points and geometries. |
| [`extract`](@ref) | extract values from points or geometries. |
| [`zonal`](@ref) | calculate zonal statistics for an object masked by geometries. |

## Methods that change the resolution or extent of an object

Click through to the function documentation for more in-depth descriptions and examples.

| Methods | Description |
| Methods | Description |
| :------------------------ | :--------------------------------------------------------------------------- |
| [`aggregate`](@ref) | aggregate data by the same or different amounts for each axis. |
| [`disaggregate`](@ref) | similarly disaggregate data. |
Expand All @@ -16,32 +24,22 @@ Click through to the function documentation for more in-depth descriptions and e

## Methods that change an objects values

!!! info
Note that most regular Julia methods, such as `replace`, work as for a standard
`Array`. These additional methods are commonly required in GIS applications.

| Methods | Description |
| Methods | Description |
| :------------------------ | :--------------------------------------------------------------------------- |
| [`classify`](@ref) | classify values into categories. |
| [`mask`](@ref) | mask an object by a polygon or `Raster` along `X/Y`, or other dimensions. |
| [`replace_missing`](@ref) | replace all missing values in an object and update `missingval`. |


## Point, polygon and table operation

| Methods | Description |
| :------------------------ | :--------------------------------------------------------------------------- |
| [`rasterize`](@ref) | rasterize points and geometries. |
| [`extract`](@ref) | extract values from points or geometries. |
| [`zonal`](@ref) | calculate zonal statistics for an object masked by geometries. |
!!! info
Note that most regular Julia methods, such as `replace`, work as for a standard
`Array`. These additional methods are commonly required in GIS applications.

## Methods to load, write and modify data sources

| Methods | Description |
| Methods | Description |
| :------------------------ | :---------------------------------------------------------------------- |
| [`modify`](@ref) | replace the data in objects. Useful to e.g. move objects to/from a GPU. |
| [`read`](@ref) | read data to memory if it is on disk. |
| [`read!`](@ref) | read data to predefined memory. |
| [`open`](@ref) | open the underlying data for manually reading or writing. |
| [`write`](@ref) | write objects to file. |

| [`write`](@ref) | write objects to file. |

0 comments on commit 367181d

Please sign in to comment.