From 61b8abf779c0bc6a2df3f16f3c729b74f71153ab Mon Sep 17 00:00:00 2001 From: Bart Huntley Date: Mon, 17 Jul 2023 11:51:48 +0800 Subject: [PATCH] version bump --- docs/404.html | 4 +- docs/LICENSE-text.html | 4 +- docs/articles/index.html | 4 +- docs/articles/one.html | 18 +++-- docs/authors.html | 8 +-- docs/index.html | 4 +- docs/news/index.html | 20 +++++- docs/pkgdown.yml | 6 +- docs/reference/DBCA_aoi.html | 9 ++- docs/reference/assemble_data.html | 22 +++--- docs/reference/fin_yr.html | 112 ++++++++++++++++++++++++++++++ docs/reference/find_block.html | 4 +- docs/reference/find_tenure.html | 4 +- docs/reference/fire_freq.html | 4 +- docs/reference/fire_interval.html | 4 +- docs/reference/index.html | 4 +- docs/reference/make_wkt.html | 4 +- docs/reference/pipe.html | 4 +- docs/reference/user_aoi.html | 4 +- docs/reference/yslb.html | 4 +- docs/sitemap.xml | 3 + 21 files changed, 201 insertions(+), 49 deletions(-) create mode 100644 docs/reference/fin_yr.html diff --git a/docs/404.html b/docs/404.html index a0af54b..3875a70 100644 --- a/docs/404.html +++ b/docs/404.html @@ -32,7 +32,7 @@ FireHistory - 0.1.0.0 + 0.2.0.0 @@ -84,7 +84,7 @@

Page not found (404)

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index faa7070..c1e7e59 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -17,7 +17,7 @@ FireHistory - 0.1.0.0 + 0.2.0.0 @@ -81,7 +81,7 @@

License

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/docs/articles/index.html b/docs/articles/index.html index c06d996..28554da 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -17,7 +17,7 @@ FireHistory - 0.1.0.0 + 0.2.0.0 @@ -59,7 +59,7 @@

Helpful guide

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/docs/articles/one.html b/docs/articles/one.html index 3a10bca..c6de3f9 100644 --- a/docs/articles/one.html +++ b/docs/articles/one.html @@ -33,7 +33,7 @@ FireHistory - 0.1.0.0 + 0.2.0.0 @@ -203,10 +203,20 @@

DBCA tenure or forest block AOI# file path to the fire history data - note includes the file extension path <- "C:/somewhere/DBCA_Fire_History_DBCA_060.shp" # here we want to temporally restrict it to the period 1988-2022 -wandoo_data <- assemble_data(fire_path = path, from = 1988, to = 2022, aoi = aoi) +wandoo_data <- assemble_data(fire_path = path, FYfrom = 1988, FYto = 2022, + aoi = aoi, accessed_on = "01/01/2023") # works the same for a forest block -jasper_data <- assemble_data(fire_path = path, from = 1988, to = 2022, aoi = aoi) +jasper_data <- assemble_data(fire_path = path, FYfrom = 1988, FYto = 2022, + aoi = aoi, accessed_on = "01/01/2023") +

A couple of things to note here.Firstly the FYfrom and +FYto parameters. The years are financial years (July-June) +not calendar years (January to December). This is because, in the south +west, the fire season occurs predominantly during the summer months. +Bear this in mind if your aoi is in the north.

+

Secondly, the accessed_on parameter is for the user to +record the date of when they accessed the DBCA_Fire_History_DBCA_060 +shapefile. This date stamp will appear as a caption on plots etc.

Whilst the fire history data is huge, as it is subset using the AOI prior to reading into memory, this process is reasonably fast (about 10-20 seconds for the wandoo data set). Saving it to an object (here @@ -257,7 +267,7 @@

Fire Metrics

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/docs/authors.html b/docs/authors.html index 0e6d502..6f3860b 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -17,7 +17,7 @@ FireHistory - 0.1.0.0 + 0.2.0.0 @@ -64,13 +64,13 @@

Citation

Huntley B (2023). FireHistory: Tools to aid querying DBCA fire history data. -R package version 0.1.0.0. +R package version 0.2.0.0. 

@Manual{,
   title = {FireHistory: Tools to aid querying DBCA fire history data},
   author = {Bart Huntley},
   year = {2023},
-  note = {R package version 0.1.0.0},
+  note = {R package version 0.2.0.0},
 }
@@ -84,7 +84,7 @@

Citation

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/docs/index.html b/docs/index.html index 2af65e2..fcacc46 100644 --- a/docs/index.html +++ b/docs/index.html @@ -34,7 +34,7 @@ FireHistory - 0.1.0.0 + 0.2.0.0 @@ -135,7 +135,7 @@

Dev status

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/docs/news/index.html b/docs/news/index.html index 56b359c..e7633ff 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -17,7 +17,7 @@ FireHistory - 0.1.0.0 + 0.2.0.0 @@ -44,6 +44,22 @@

Changelog

+
+

FireHistory 0.2.0.0

+

This is a major release adding new features and fixing a number of bugs

+
+

Bug fixes

+
  • Error when trying to run fire_freq (#7)
    • +
  • Error when trying to run fire_interval (#8)
    • +
+
+

Major changes

+
  • Cropping of raster data was previously done using the aoi vector, which could introduce inconsistencies in reporting areas. An aoi raster mask addresses this.
    • +
  • The time periods are financial years (July-June) not calendar years (January-December). This is due to the fact that the fire season in the south west predominantly occurs during the summer months. Bear this in mind when analysing fires in the north.
    • +
  • YSLB now contains an “unknown” category. This category is applied to any area in the aoi where there is no burn history for the time period chosen. It is reported on in exported stats and is represented in the map as a grey region bordered by a red boundary.
    • +
  • Better axis labeling for column charts.
    • +
+

FireHistory 0.1.0.0

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index d79a252..32e9045 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -1,9 +1,9 @@ -pandoc: 2.19.2 -pkgdown: 2.0.6 +pandoc: 3.1.1 +pkgdown: 2.0.7 pkgdown_sha: ~ articles: one: one.html -last_built: 2023-03-02T07:56Z +last_built: 2023-07-17T03:46Z urls: reference: https://dbca-wa.github.io/FireHistory/reference article: https://dbca-wa.github.io/FireHistory/articles diff --git a/docs/reference/DBCA_aoi.html b/docs/reference/DBCA_aoi.html index 07d6070..e8c989c 100644 --- a/docs/reference/DBCA_aoi.html +++ b/docs/reference/DBCA_aoi.html @@ -18,7 +18,7 @@ FireHistory - 0.1.0.0 + 0.2.0.0 @@ -62,6 +62,11 @@

Arguments

as determined by previously running find_tenure() or find_block().

+ +
block
+

logical. Is the choice a forest block? Enables search of correct +shape file of extents.

+

Value

@@ -97,7 +102,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/docs/reference/assemble_data.html b/docs/reference/assemble_data.html index ac79fdd..f2c92e2 100644 --- a/docs/reference/assemble_data.html +++ b/docs/reference/assemble_data.html @@ -18,7 +18,7 @@ FireHistory - 0.1.0.0 + 0.2.0.0 @@ -52,7 +52,7 @@

Assemble data for calculating fire metrics

- 
assemble_data(fire_path, from, to, aoi)
+ 
assemble_data(fire_path, FYfrom, FYto, aoi, accessed_on = NULL)
@@ -63,20 +63,26 @@

Arguments

file extension ".shp"

-
from
+
FYfrom

numeric representing the starting year for the analysis and -generation of metrics.

+generation of metrics. Years are financial year (July-June).

-
to
+
FYto

numeric representing the current year for the analysis and -generation of metrics.

+generation of metrics. Years are financial year (July-June).

aoi

the aoi object previously created by using either user_aoi() or DBCA_aoi()

+ +
accessed_on
+

date that the DBCA Fire History DBCA 060 shape file was +downloaded and accessed. Defaults to NULL. Intention is to be able to track +of when the data was accessed as over time the base data will be updated.

+

Value

@@ -107,7 +113,7 @@

Author

Examples

if (FALSE) {
 fire_data <- assemble_data(fire_path = "C:/path/to/data/DBCA_Fire_History_DBCA_060.shp",
-from = 1988, to = 2022, aoi = aoi)
+FYfrom = 1988, FYto = 2022, aoi = aoi, accessed_on = "01/01/1901")
 }
@@ -124,7 +130,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/docs/reference/fin_yr.html b/docs/reference/fin_yr.html new file mode 100644 index 0000000..65ae614 --- /dev/null +++ b/docs/reference/fin_yr.html @@ -0,0 +1,112 @@ + +Calculate financial year and quarter from a date — fin_yr • FireHistory + + +
+
+ + + +
+
+
+

Calculate financial year and quarter from a date

+ + +
+ +
+

fin_yr takes a date object and a statring month and calculates a financial +year and quarter.

+
+ +
+ 
fin_yr(x, fs = 7)
+
+ +
+

Arguments

+
x
+

a year object

+ + +
fs
+

start month in numerical representation. Defaults to 7 for a standard +Australian finacial year.

+ +
+
+

Value

+ + +

a character string in the format YYYY_Q, where YYYY is the finacial +year and Q is the numerical quarter of that finacial year.

+
+
+

Author

+

Bart Huntley, bart.huntley@dbca.wa.gov.au

+
+ +
+

Examples

+ 
if (FALSE) {
+f_q <- fin_yr(x = 2023-02-23, fs = 7)
+}
+
+
+
+
+ +
+ + +
+

Developed by Bart Huntley.

+
+ +
+

Site built with pkgdown 2.0.7.

+
+ +
+ + + + + + + + diff --git a/docs/reference/find_block.html b/docs/reference/find_block.html index da0435b..aa6e5c7 100644 --- a/docs/reference/find_block.html +++ b/docs/reference/find_block.html @@ -17,7 +17,7 @@ FireHistory - 0.1.0.0 + 0.2.0.0 @@ -100,7 +100,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/docs/reference/find_tenure.html b/docs/reference/find_tenure.html index 12b35d3..a421bac 100644 --- a/docs/reference/find_tenure.html +++ b/docs/reference/find_tenure.html @@ -17,7 +17,7 @@ FireHistory - 0.1.0.0 + 0.2.0.0 @@ -100,7 +100,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/docs/reference/fire_freq.html b/docs/reference/fire_freq.html index 36de533..2a3199f 100644 --- a/docs/reference/fire_freq.html +++ b/docs/reference/fire_freq.html @@ -18,7 +18,7 @@ FireHistory - 0.1.0.0 + 0.2.0.0 @@ -111,7 +111,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/docs/reference/fire_interval.html b/docs/reference/fire_interval.html index e9dd058..d952f6e 100644 --- a/docs/reference/fire_interval.html +++ b/docs/reference/fire_interval.html @@ -18,7 +18,7 @@ FireHistory - 0.1.0.0 + 0.2.0.0 @@ -118,7 +118,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/docs/reference/index.html b/docs/reference/index.html index b352cfc..e0cc9c4 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -17,7 +17,7 @@ FireHistory - 0.1.0.0 + 0.2.0.0 @@ -96,7 +96,7 @@

Making Metrics
-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/docs/reference/make_wkt.html b/docs/reference/make_wkt.html index ac2199d..24f7d74 100644 --- a/docs/reference/make_wkt.html +++ b/docs/reference/make_wkt.html @@ -18,7 +18,7 @@ FireHistory - 0.1.0.0 + 0.2.0.0 @@ -97,7 +97,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/docs/reference/pipe.html b/docs/reference/pipe.html index 85b4bfc..a3095e7 100644 --- a/docs/reference/pipe.html +++ b/docs/reference/pipe.html @@ -17,7 +17,7 @@ FireHistory - 0.1.0.0 + 0.2.0.0 @@ -82,7 +82,7 @@

Value

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/docs/reference/user_aoi.html b/docs/reference/user_aoi.html index 3952940..7274aab 100644 --- a/docs/reference/user_aoi.html +++ b/docs/reference/user_aoi.html @@ -18,7 +18,7 @@ FireHistory - 0.1.0.0 + 0.2.0.0 @@ -107,7 +107,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/docs/reference/yslb.html b/docs/reference/yslb.html index 5fc0f14..be5c399 100644 --- a/docs/reference/yslb.html +++ b/docs/reference/yslb.html @@ -18,7 +18,7 @@ FireHistory - 0.1.0.0 + 0.2.0.0 @@ -110,7 +110,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 0b3604b..8095c49 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -33,6 +33,9 @@ https://dbca-wa.github.io/FireHistory/reference/find_tenure.html + + https://dbca-wa.github.io/FireHistory/reference/fin_yr.html + https://dbca-wa.github.io/FireHistory/reference/fire_freq.html