burnr v0.6.1

Changes in this release:

• Test for new ks.test behavior in r-devel. (@brews, PR #191)

• Update DOI badge and support documentation on main website and README. (@chguiterman, PR #182)

burnr v0.6.0

Changes in this release:

• Add rlang, stringr, forcats, and tidyr as package dependencies.

• Fix bug in plot_demograph() to handle discontinuous recording periods. Thanks to Mannie Lopez for finding that this addition disrupted the series sorting. (@chguiterman, #78)

• Fix bug where "springdormant_fs" was omitted from the list of scar types in burnr:::rec_type_recording. This caused problems in the calculation of percent_scarred() because too few trees were recognized as recording in the year of fire. This would have also caused problems in composite(). Thanks to @GuobaoXu for finding the error and tracing its origin. (@chguiterman, #162, #167)

• Change to format of FHX2 files output from write_fhx() to include a space between the data block and years. (@chguiterman, #162)

• Add flexibility to read_fhx() to handle extra space at bottom of file. This is commonly present in some non-standardized FHX files available on the IMPD. (@chguiterman, #162, #164)

• Add DOI badge to the README. (@chguiterman, #162)

• Add a new example to get_year() documentation to aid users subsetting an fhx object based on before/after a particular cut-off year. (@chguiterman, #173)

• Update count_event_position() to accommodate non-standard positions in rec_type. (@chguiterman, #161)

• Add "spring dormant" to the set of rec_types. This is a non-standard descriptor for fire scar seasonality. This aids with cases where "D" dormant scars as the unknown year of a dormant scar (in the Northern Hemisphere). (@chguiterman, #161)

• Update README creation to Rmarkdown (.Rmd) file with usethis::use_readme_rmd(). (@chguiterman, #161)

• Fix typo in citation file. (@chguiterman, #161)

• Add general unit tests to increase test coverage.

burnr v0.5.0

Changes in this release:

• Added as_fhx() (Issue #120). This takes data frames, tibbles, and lists as input. It assumes they have "year", "series", and "rec_type" elements/columns. It returns an fhx object. Additionally, the fhx() constructor now also uses type casting for input (Issue #150) - so no more worrying if your rec_types are factors or character vectors. These changes are a big improvement for anyone working in the tidyverse or anyone working with thier own non-FHX fire-history file formats.

• Extensive improvement to documentation (e.g. Issue #145). This includes new "See Also" sections (so users can find cool functions), fixes for spelling errors, and clarifications to dyslexic prose.

• write_fhx() will now throw a warning if users try to write an fhx object that has record types violating the FHX2 file convention (Issue #149). I still strongly recommend using write.csv(...) on fhx objects and as.fhx(read.csv(...)) for IO with experimental fhx data.

• Removed deprecated run_sea(). Be sure to use sea() now.

• Removed deprecated get_ggplot(). Please use plot_demograph() now.

• Removed broken site_stats() function (Issue #138). Please use intervals() and print() to get the same statistics.

• composite() now returns an empty fhx object if no composite-worthy events are found (Issue #131) or if there are no fire-events (Issue #155). Much better than throwing an obtuse error, which is what we used to do.

• Updated in-package citation information (citation("burnr")). Please cite burnr if you use it in your work!

• yearly_recording() now returns a data frame with a numeric "year" column (Issue #154). In past versions, the "year" column contained factors.

• Added unit tests for basic plotting function options. We now have test coverage for more than 75% of our code.

• Minor internal code cleanup (Issue #130, Issue #88, Issue #133, Issue #136, Issue #88, Issue #146) and code linting.

burnr v0.4.0

Changes in this minor release:

• read_fhx() is more tolerant of extra whitespace in series names. Thanks to Chris Guiterman (@chguiterman) for adding this.

• Fixed documentation examples not rendering for sea() (Issue #125).

• Minor argument clarification in composite() documentation (Issue #127).

burnr v0.3.1

Changes in this patch:

• Updates to documentation and README.

• Quick fixes to SEA unit tests, forcing them to use R 3.5.0 RNG as a temporary fix to issue #124.

burnr v0.3.0

Changes in this minor release:

• Change to sea objects, added event_years.

• Added function percent_scarred() for calculating timeseries of number trees recording, scarred, and the percentage.

• Update to sample_depth() to account for single-series fhx objects

• Several updates to documentation, including citation.

burnr v0.2.2

Changes in this patch:

• Added warnings and errors to catch bad input on seas() (#112).

• Added warning if using series_mean_interval() on fhx object with multiple series (#113).

• Fixed bad numbers in print() for SEAs objects (#111).

• Fixed typos in warning messages (#114).

burnr v0.2.1

Changes in this patch:

• intervals objects' KS test for distribution test is now two sided (Issue #108).

• Printed intervals objects now report the Weibull median, regardless of fit chosen (Issue #109).

burnr v0.2.0

Changes in this minor release:

• Renamed run_sea() to sea() and enhanced speed, and changed the time_span parameter to event_range, key argument is now event, and years_before and years_after are now nbefore and nafter, respectively. The function now returns a proper sea object with special plot() and print() methods. The plot() generic method uses the new plot_sealags(). You can still use the old run_sea(), but it is deprecated and will be removed in future releases. We're happy with the general interfaces to sea() but its internal structure may change over the next few minor releases, so beware.

• Added intervals() to handle interval analysis. These are a whole new object. mean_interval() has been renamed series_mean_interval() to avoid confusion. We also have a generic plot() function that uses plot_intervals_dist(). It plots a little histogram with a rug along the x-axis.

• Added pgm_pdsi data to run with sea. Load it with data("pgm_pdsi").

• Added make_rec_type(). I hope this will make it easier to create rec_type factors used by fhx().

• Added event_count_position(), which gives the number of events found in different positions or seasons.

• Added year_range() to give (min, max) years for an fhx object.

• Updated composite() to include a filter for number of events. This necesitates fixes in other functions (e.g. plot_demograph()).

• Added summary() function for fhx and intervals objects.

• count_fire() renamed count_scar()

• Added quantile() function for intervals.

burnr v0.1.2

Changes in this patch:

• Fixed bug in read_fhx() caused by "FHX2 format" in FHX file header.
• Fixed bug #71, causing read_fhx() to fail when FHX has empty last line.
• Added text option to read_fhx().
• Corrected error message for series arg in fhx(). Fixes #73.
• Fixed write_fhx() reversing order of series names in output file.