Skip to content

Commit

Permalink
doc: fix details blocks
Browse files Browse the repository at this point in the history
  • Loading branch information
tpoisot committed Sep 27, 2024
1 parent f1948a9 commit 4983891
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 10 deletions.
12 changes: 6 additions & 6 deletions docs/src/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,36 +58,36 @@ all the functions and types exported by the component packages. This is the
A wrapper around the GBIF API, to retrieve taxa and occurrence datasets, and
perform filtering on these occurrence data based on flags.

![GitHub Release](https://img.shields.io/github/v/release/poisotlab/speciesdistributiontoolkit.jl?filter=GBIF-*&style=flat-square&label=GBIF.jl) [![DOC](https://img.shields.io/badge/Manual-teal?style=flat-square)](https://poisotlab.github.io/SpeciesDistributionToolkit.jl/GBIF/) ![Lifecycle:Stable](https://img.shields.io/badge/Lifecycle-Stable-97ca00?style=flat-square)
![GitHub Release](https://img.shields.io/github/v/release/poisotlab/speciesdistributiontoolkit.jl?filter=GBIF-*&style=flat-square&label=GBIF.jl) ![Lifecycle:Stable](https://img.shields.io/badge/Lifecycle-Stable-97ca00?style=flat-square)

### Getting environmental data: `SimpleSDMDatasets.jl`

An efficient way to download and store environmental raster data for consumption
by other packages.

![GitHub Release](https://img.shields.io/github/v/release/poisotlab/speciesdistributiontoolkit.jl?filter=SimpleSDMDatasets-*&style=flat-square&label=SimpleSDMDatasets.jl) [![DOC](https://img.shields.io/badge/Manual-teal?style=flat-square)](https://poisotlab.github.io/SpeciesDistributionToolkit.jl/SimpleSDMDatasets/) ![Lifecycle:Stable](https://img.shields.io/badge/Lifecycle-Stable-97ca00?style=flat-square)
![GitHub Release](https://img.shields.io/github/v/release/poisotlab/speciesdistributiontoolkit.jl?filter=SimpleSDMDatasets-*&style=flat-square&label=SimpleSDMDatasets.jl) ![Lifecycle:Stable](https://img.shields.io/badge/Lifecycle-Stable-97ca00?style=flat-square)

### Using environmental data: `SimpleSDMLayers.jl`

A series of types and common operations on raster data.

![GitHub Release](https://img.shields.io/github/v/release/poisotlab/speciesdistributiontoolkit.jl?filter=SimpleSDMLayers-*&style=flat-square&label=SimpleSDMLayers.jl) [![DOC](https://img.shields.io/badge/Manual-teal?style=flat-square)](https://poisotlab.github.io/SpeciesDistributionToolkit.jl/SimpleSDMLayers/) ![Lifecycle:Maturing](https://img.shields.io/badge/Lifecycle-Maturing-007EC6?style=flat-square)
![GitHub Release](https://img.shields.io/github/v/release/poisotlab/speciesdistributiontoolkit.jl?filter=SimpleSDMLayers-*&style=flat-square&label=SimpleSDMLayers.jl) ![Lifecycle:Maturing](https://img.shields.io/badge/Lifecycle-Maturing-007EC6?style=flat-square)

### Simulating occurrence data: `Fauxcurrences.jl`

A package to simulate realistic species occurrence data from a know series of
occurrences, with additional statistical constraints.

![GitHub Release](https://img.shields.io/github/v/release/poisotlab/speciesdistributiontoolkit.jl?filter=Fauxcurrences-*&style=flat-square&label=Fauxcurrences.jl) [![DOC](https://img.shields.io/badge/Manual-teal?style=flat-square)](https://poisotlab.github.io/SpeciesDistributionToolkit.jl/Fauxcurrences/) ![Lifecycle:Maturing](https://img.shields.io/badge/Lifecycle-Maturing-007EC6?style=flat-square)
![GitHub Release](https://img.shields.io/github/v/release/poisotlab/speciesdistributiontoolkit.jl?filter=Fauxcurrences-*&style=flat-square&label=Fauxcurrences.jl) ![Lifecycle:Maturing](https://img.shields.io/badge/Lifecycle-Maturing-007EC6?style=flat-square)

### Getting organisms silhouettes: `Phylopic.jl`

A wrapper around the Phylopic API.

![GitHub Release](https://img.shields.io/github/v/release/poisotlab/speciesdistributiontoolkit.jl?filter=Phylopic-*&style=flat-square&label=Phylopic.jl) [![DOC](https://img.shields.io/badge/Manual-teal?style=flat-square)](https://poisotlab.github.io/SpeciesDistributionToolkit.jl/Phylopic/) ![Lifecycle:Stable](https://img.shields.io/badge/Lifecycle-Stable-97ca00?style=flat-square)
![GitHub Release](https://img.shields.io/github/v/release/poisotlab/speciesdistributiontoolkit.jl?filter=Phylopic-*&style=flat-square&label=Phylopic.jl) ![Lifecycle:Stable](https://img.shields.io/badge/Lifecycle-Stable-97ca00?style=flat-square)

### Teaching and workshops: `SDeMo.jl`

A series of very simple SDMs and utility functions for education.

![GitHub Release](https://img.shields.io/github/v/release/poisotlab/speciesdistributiontoolkit.jl?filter=SDeMo-*&style=flat-square&label=GBIF.jl) [![DOC](https://img.shields.io/badge/Manual-teal?style=flat-square)](https://poisotlab.github.io/SpeciesDistributionToolkit.jl/SDeMo/) ![Lifecycle:Maturing](https://img.shields.io/badge/Lifecycle-Maturing-007EC6?style=flat-square)
![GitHub Release](https://img.shields.io/github/v/release/poisotlab/speciesdistributiontoolkit.jl?filter=SDeMo-*&style=flat-square&label=SDeMo.jl) ![Lifecycle:Maturing](https://img.shields.io/badge/Lifecycle-Maturing-007EC6?style=flat-square)
3 changes: 2 additions & 1 deletion docs/src/tutorials/fauxcurrences.jl
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,8 @@ scatter!(ax3, bin_s_intra[3], color=:transparent, strokewidth=2, strokecolor=:or
[hidedecorations!(ax) for ax in [ax1, ax2, ax3]]
current_figure() #hide

# For the components of the inter-specific distance matrix, this looks like:
# For the components of the inter-specific distance matrix, this gives the
# following plot:

# fig-distances-inter
f = Figure(; size=(700, 250))
Expand Down
6 changes: 4 additions & 2 deletions docs/src/tutorials/polygons.jl
Original file line number Diff line number Diff line change
Expand Up @@ -57,15 +57,17 @@ layer = SDMLayer(
heatmap(layer; colormap = :navia, axis = (; aspect = DataAspect()))
current_figure() #hide

# We can now mask this layer according to the polygon:
# We can now mask this layer according to the polygon. This uses the same
# `mask!` method we use when masking with another layer:

mask!(layer, CHE)

# fig-region-masked
heatmap(layer; colormap = :navia, axis = (; aspect = DataAspect()))
current_figure() #hide

# This is a much larger layer than we need! For this reason, we will trim it so that the empty areas are removed:
# This is a much larger layer than we need! For this reason, we will trim it so
# that the empty areas are removed:

# fig-region-trimmed
heatmap(trim(layer); colormap = :navia, axis = (; aspect = DataAspect()))
Expand Down
3 changes: 2 additions & 1 deletion docs/src/tutorials/zonal.jl
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ hidespines!(ax)
hidedecorations!(ax)
current_figure() #hide

# We can now get the lower level sub-division:
# We can now get the lower level sub-division. Note that not all territories
# covered by GADM have the same number of sub-divisions!

districts = SpeciesDistributionToolkit.gadm("NZL", 2);

Expand Down

0 comments on commit 4983891

Please sign in to comment.