Skip to content

Latest commit

 

History

History
298 lines (201 loc) · 9.37 KB

NEWS.md

File metadata and controls

298 lines (201 loc) · 9.37 KB

MazamaCoreUtils 0.5.3

  • The loadDataFile() function now includes a priority argument so that either dataUrl or dataDir can be prioritized with the other as a backup if initial loading of data fails.

MazamaCoreUtils 0.5.2

  • initializeLogging() now creates a WARN.log file to complete the suite of TRACE, DEBUG, INFO, WARN and ERROR.

MazamaCoreUtils 0.5.1

  • Addressed CRAN check error.
  • Added precision argument to createLocationID().

MazamaCoreUtils 0.5.0

  • Updated dependencies to R 4.0.0 and rlang 1.1.0.
  • initializeLogging() now properly uses filePrefix argument.
  • The timeStamp() function now defaults to lubridate::now("UTC") when no datetime is provided. This supports common use cases such as:
> timeStamp(unit = "hour")
[1] "2023102618"
> timeStamp(style = "clock")
[1] "2023-10-26T18:25:55"
  • Updated imports from futile.logger to avoid error messages like this: WARN [2023-08-29 14:06:58] Oops: object 'flog.appender' not found
  • Added createLocationMask() to identify invalid locations.
  • createLocationID() now defaults to algorithm = "geohash".
  • createLocationID() now returns the user specified invalidID for invalid locations rather than stopping with an error message.

MazamaCoreUtils 0.4.16

  • Addressed CRAN package documentation issue.

MazamaCoreUtils 0.4.15

  • `parseDatetime() now supports data formats with UTC offset: "2018-10-16 12:00:00+00:00".

MazamaCoreUtils 0.4.14

  • Added algorithm argument to createLocationID() to select between "digest" and "geohash".

The "geohash" algorithm is preferred but the "digest" algorithm is retained (and the default) because several existing databases use the "digest" algorithm as a unique identifier.

MazamaCoreUtils 0.4.13

  • Updated stopOnError() function documentation and associated vignette.

MazamaCoreUtils 0.4.12

  • Updated stopOnError() with the following additional arguments: prefix, code, maxLength, truncatedLength, call..
  • Corrected documentation for timeStamp().

MazamaCoreUtils 0.4.11

  • Changed examples in html_getLinks() and html_getTables() to explain any errors with: try({ ...}, silent = FALSE).

MazamaCoreUtils 0.4.10

  • New functions for managing API keys: getAPIKey(), setAPIKey(), showAPIKeys().
  • Now exporting futile.logger::flog.layout() to avoid downstream complaints.
  • Examples for html_getLinks() and html_getTables() now fail gracefully.
  • Consolidated the local_~/ directories. (Not part of the R package.)

MazamaCoreUtils 0.4.9

  • Updated R dependency to R (>= 3.5.0).
  • Added filePrefix and createDir arguments to initializeLogging().
  • Added location utility functions: validateLonLat(), validateLonsLats() and createLocationID().
  • Harmonized error messages to begin with lower case and not include a period.
  • Added Zenodo DOI.

MazamaCoreUtils 0.4.8

  • Fixed bug in dateRange() when creating single day date ranges.
  • Added "ymdThms" format to timeStamp().
  • Added "msec" unit option to timestamp().
  • Renamed default branch from 'master' to 'main'.

MazamaCoreUtils 0.4.7

  • Updated html_getTable() to not disregard the index parameter.

MazamaCoreUtils 0.4.6

  • Updated check_~() functions to use devtools::check() manual and run_dont_test arguments.

MazamaCoreUtils 0.4.5

  • Added header option to html_getLinks() and html_getTables() functions.

MazamaCoreUtils 0.4.4

  • Added new html_getLinks() and html_getTables() functions.

MazamaCoreUtils 0.4.3

  • Now exporting futile.logger::flog.layout() to avoid downstream complaints.
  • Updated documentation for check_~() functions.

MazamaCoreUtils 0.4.2

  • Fixed error messaging in loadDataFile().
  • Added ceilingStart argument to dateRange() and timeRange().

MazamaCoreUtils 0.4.1

  • Fixed improper handling of single day date ranges in dateRange().

MazamaCoreUtils 0.4.0

This version address a few issues encountered while using 0.3.11 in production.

  • New timeStamp() function creates character timestamps useful for labeling.
  • New dateSequence() function generates a sequence of POSIXct values that align with midnight local time even through the switch to/from daylight savings.
  • New loadDataFile() function supports loading data from local directories or URLs.
  • Added year-only support to parseDatetime() when parsing julian dates.
  • Renamed parsDatetime() argument julian to isJulian.
  • stopIfNull() and setIfNull() now issue stop(...) messages with call. = TRUE so that the stack information bubbles up.
  • Now exporting futile.logger::flog.logger() to avoid downstream complaints.

MazamaCoreUtils 0.3.11

  • Added this package's own date parsing functions to timezoneLintrules.

MazamaCoreUtils 0.3.10

  • parseDatetime() now supports YYYY and YYYYmm formats.

MazamaCoreUtils 0.3.9

  • Added julian argument to parseDatetime() to support Julian day formats.

MazamaCoreUtils 0.3.8

Added a suite of functions to easily run devtools::check() with different arguments:

  • check_fastest()

  • check_faster()

  • check_fast()

  • check()

  • check_slow()

  • check_slower()

  • check_slowest()

  • Added more lubridate functions to timezoneLintRules.

MazamaCoreUtils 0.3.7

  • Added logger.isInitialized() for programmatic use.
  • logger.setLevel() now guarantees that logger.setup() has been called, fixing a bug that generated multiple output messages when logger.setLevel() was called before logger.setup().
  • Added more lubridate functions to timezoneLintRules.

MazamaCoreUtils 0.3.6

More consistency improvements to dateRange(). When specified, the days parameter now takes precedence over ceilingEnd when no enddate is specified.

MazamaCoreUtils 0.3.5

Fully self-consistent package using internal functions wherever possible.

MazamaCoreUtils 0.3.4

Various improvements after usage in an operational setting:

  • timezoneLintRules includes more date related functions.
  • Added quiet argument to parseDateTime().
  • timeRange() function now accepts unit and ceilingEnd arguments.
  • dateRange() function now accepts ceilingEnd argument.
  • More unit tests for dates and times.

The ceilingEnd argument addresses the ambiguity of a phrase like: "August 1-8". With ceilingEnd = FALSE (default) this pharse means "through the beginning of Aug 8". With ceilingEnd = TRUE it means "through the end of Aug 8".

MazamaCoreUtils 0.3.3

This version adds new convenience functions for dealing with NULL values in pipeline flow control.

New functions

  • setIfNull()
  • stopIfNull()

Dealing with NULL values

In a lot of the data pipelines we build (web services, packages, etc.), we need to deal with the possibility of NULL inputs. Setting a default value or throwing an error are two of the most common ways NUll values are dealt with. While the code to handle this is straightforward to write, it is verbose and repetitive. setIfNull() and stopIfNull() are designed to abstract away boilerplate code, allowing us to focus on more important things.

MazamaCoreUtils 0.3.2

  • Improved documentation for enddate in `dateRange().

MazamaCoreUtils 0.3.1

  • Tweak for CRAN.
  • Renamed lintFunctionArgs_directory() to lintFunctionArgs_dir().
  • Added fullPath argument to linting functions.
  • Added date-parsing vignette.

MazamaCoreUtils 0.3.0

This version focuses on enhancing the time utility capabilities of MazamaCoreUtils.

New functions

  • lintFunctionArgs_file()
  • lintFunctionArgs_directory()
  • timeRange()
  • parseDatetime()

Function Argument Linting

In order to ensure that we are working with timezones consistently, the functions lintFunctionArgs_file() and lintFunctionArgs_directory() were created to parse R source files and determine if certain functions contained specific named arguments, based on a set of rules. A set of rules, timezoneLintRules, was created to check that all functions that accept a timezone have that argument explicitly fill, avoiding inconsistent default behavior.

Consolidating Time-Utility functions

PWFSLSmoke::parseDatetime() was moved into MazamaCoreUtils so more packages can benefit from it without importing the rest of PWFSLSmoke. Also, timeRange() was created to work as a function analogous to dateRange(), parsing time ranges instead of finding date ranges.

As part of this consolidation, more unit tests were added to the package.

MazamaCoreUtils 0.2.1

  • Reordered arguments to dateRange().
  • dateRange() no longer provides a default timezone.
  • dateRange() no longer alters POSIXct inputs
  • dateRange() now has stricter argument checking

MazamaCoreUtils 0.2.0

  • Moved futile.logger from Depends to Imports.
  • Version bump.

MazamaCoreUtils 0.1.901

  • Add linter
  • Add Rproj file
  • Minor style refactor

MazamaCoreUtils 0.1.900

  • Added dateRange() function.

MazamaCoreUtils 0.1.3

  • Added pkgdown documentation.
  • New vignettes for error-handling and logging.
  • Package now Depends: on futile.logger -- avoids futile.logger not found error messages.
  • Additional logging unit tests.

MazamaCoreUtils 0.1.2

  • Added maxFileAge parameter to cacheManagement() to help with removal of out-of-data products.
  • New dependencies on magrittr and rlang packages.

MazamaCoreUtils 0.1.1

  • Minor cleanup and documentation improvements.

MazamaCoreUtils 0.1.0

  • Initial functionality.