Release Notes¶
0.2.0 (2026-11-03)¶
Bug fixes¶
The install issue related to package data has been fixed.
The package info to document Python support up to 3.14 has been updated
The
change_dates()function has been upgraded to fix flip-flopping start and end date values.The EWMA detector has been updated to closely match the
Rnssp’s implementation. In addition, thealert_ewma()function has been updated with a patch to prevent errors when detector is applied to a zero series.The Regression detector has been updated to closely match the
Rnssp’s implementation.The Switch detector has been updated to closely match the
Rnssp’s implementation.
New Features¶
Anomaly Detection¶
The Farrington Temporal Detector algorithm
alert_farrington()has been added for weekly time series of counts spanning multiple years.
Credentials Management¶
A new abstract class
Authhas been added.Both the
CredentialsandTokenclasses inherit theAuthclass.A new
Apikeyclass has been added for API services token use.
Classes¶
The
Authclass delineates methods Shared by theToken,Credentials, andApikeyClasses. The newApikeyclass inherits theAuthclass, and has the same methods as theCredentialsandTokenclasses.
Utility Functions¶
A new
create_apikey_profile()function has been added as a wrapper to theApikeyclass.
Other¶
A section on the Farrington Temporal detector has been added to the Anomaly Detection vignette.
A trend classification section has been added to the Anomaly Detection vignette.
A new vignette entitled “Text Mining Example” has been added to the package documentation.
The online documentation has a new theme.
0.1.0 (2023-06-22)¶
First release on PyPI.
Features¶
Credentials Management¶
create_profile()initializes aCredentialsobject from a username and password.create_token_profile()initializes aTokenobject from a REST API token.
REST API data pulls¶
get_api_response()retrieves a response from an API service using a provided profile of typeCredentialsorToken. Used as a wrapper to the.get_api_response()method of a provided profile of typeCredentialsorToken.get_api_data()retrieves data (in JSON or CSV) from an API service using a provided profile of typeCredentialsorToken. Used as a wrapper to the.get_api_data()method of a provided profile of typeCredentialsorToken.get_api_graph()retrieves a graph from an API service using a provided profile of typeCredentialsorToken. Used as a wrapper to the.get_api_graph()method of a provided profile of typeCredentialsorToken.get_essence_data()retrieves data from the NSSP-ESSENCE API service using a provided profile of typeCredentialsorToken.
Anomaly Detection and Trend Classification¶
alert_ewma()implements the EWMA time series anomaly detection algorithm.alert_regression()implements the Multiple Adaptive Regression time series anomaly detection algorithm.alert_switch()implements the Regression/EWMA Switch time series anomaly detection algorithmalert_nbinom()implements the Negative Binomial Regression time series anomaly detection algorithm.alert_serfling()implements the original and modified Serfling method for time series anomaly detection.classify_trend()fits rolling binomial models to a daily time series of percentages or proportions to classify the overall trend.
Added Data¶
load_simulated_ts()loads a dataframe of simulated time series.load_nssp_stopwords()loads a dataframe of NSSP-curated stopwords.get_scenario1()loads a a subset of the simulated time series data (“scenario #1”).get_scenario2()loads a a subset of the simulated time series data (“scenario #2”).
Utility Functions¶
change_dates()modifies the start and end dates in a given URL to new dates, if provided.webscrape_icd()scrapes ICD Codes from the Web.
Classes¶
Credentialsis an abstract representation of a profile object given a username and password strings.Tokenis an abstract representation of a profile object given a token string.APIGraphis an abstract representation of a graph object returns from an API service.NSSPContainerencapsulates a value or an object to store.