Skip to content

Commit

Permalink
Doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
burkmarr committed Dec 4, 2024
1 parent 5fb4abc commit d2f970e
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
For API details - [JSDoc API documentation](https://biologicalrecordscentre.github.io/brc-charts/docs/api/).

## Working chart examples

### Temporal charts
The temporal chart (`brccharts.temporal`) can be used for all sorts of charts which require
their x-axis to span either a year (e.g. for phenology) or a number of years (e.g. to visualise
Expand All @@ -12,25 +13,30 @@ the accumulation of records over time). This is probably the most widely useful
- [Temporal charts interactive](example-9.html)
- [UKBMS interactive](example-ukbms-1.html)
- [UKBMS example](example-ukbms-2.html)

### Pie/donut charts
The pie/donut chart (`brccharts.pie`) does what it says on the tin. Example:
- [Pie/donut charts](example-1.html)

### Phenology charts
The phenology chart (`brccharts.phen2`) is a specific type of temporal chart which
is purely for displaying phenological data. Example:
- [Phenology bands](example-10.html)

### Accumulation charts
The accumulation chart (`brccharts.accum`) was created for a very specific use case to chart record accumulation
over the course of a year, displaying both the cummulative number of taxa and
the cummulative number of records together. Example:
- [Species/record accumulation charts](example-3.html)

### Trend charts
Also created for a very specific use case, the trend chart (`brccharts.trend`) displays two graphics: 1) a bar
chart showing the absolute yearly counts for each taxon shown and 2) a line graph showing,
for each year, the percetage of the sum of counts for all species in that year
which the count for the taxon represents. Two y-axes are shown (left and right) to reflect these
two metrics.
- [Trend charts](example-5.html)

### Latitude vs altitude charts
Another very specific use case, the latitude vs altitude chart (`brccharts.altlat`) is based on that which appears in the
[Atlas of British and irish Bryophytes](https://www.britishbryologicalsociety.org.uk/publications/atlas-of-british-and-irish-bryophytes/).
Expand All @@ -56,11 +62,13 @@ It has not been developed past the point required to produce the example shown b
There are a couple of undocumented charts in the libarary - i.e. they do not appear in
the [API documentation](https://biologicalrecordscentre.github.io/brc-charts/docs/api/).
These were developed for the the [Plant Atlas 2020 website](https://plantatlas2020.org/).

### Undocumented 'bar' chart
The bar chart (`brccharts.bar`) is designed to display a bar chart.
Although initiallly created to facilitate the [Plant Atlas 2020 website](https://plantatlas2020.org/)
(figure 4 on the 'trends' tab),
it has been generalised and could be used in other contexts
it has been generalised and could be used in other contexts.

### Undocumented 'density' chart
The density chart (`brccharts.density`) is designed to show one or more density plots
derived from frequency data (data)
Expand Down

0 comments on commit d2f970e

Please sign in to comment.