Package: nixtlar 0.5.4
Mariana Menchero
nixtlar: A Software Development Kit for 'Nixtla''s 'TimeGPT'
A Software Development Kit for working with 'Nixtla''s 'TimeGPT', a foundation model for time series forecasting. 'API' is an acronym for 'application programming interface'; this package allows users to interact with 'TimeGPT' via the 'API'. You can set and validate 'API' keys and generate forecasts via 'API' calls. It is compatible with 'tsibble' and base R. For more details visit <https://docs.nixtla.io/>.
Authors:
nixtlar_0.5.4.tar.gz
nixtlar_0.5.4.zip(r-4.5)nixtlar_0.5.4.zip(r-4.4)nixtlar_0.5.4.zip(r-4.3)
nixtlar_0.5.4.tgz(r-4.4-any)nixtlar_0.5.4.tgz(r-4.3-any)
nixtlar_0.5.4.tar.gz(r-4.5-noble)nixtlar_0.5.4.tar.gz(r-4.4-noble)
nixtlar_0.5.4.tgz(r-4.4-emscripten)nixtlar_0.5.4.tgz(r-4.3-emscripten)
nixtlar.pdf |nixtlar.html✨
nixtlar/json (API)
NEWS
| # Install 'nixtlar' in R: |
| install.packages('nixtlar', repos = c('https://nixtla.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/nixtla/nixtlar/issues
- electricity - Electricity dataset
- electricity_exo_vars - Electricity dataset with exogenous variables
- electricity_future_exo_vars - Future values for the electricity dataset with exogenous variables
Last updated 15 days agofrom:e4834b5c52. Checks:OK: 3 NOTE: 4. Indexed: yes.
| Target | Result | Date |
|---|---|---|
| Doc / Vignettes | OK | Sep 02 2024 |
| R-4.5-win | NOTE | Sep 02 2024 |
| R-4.5-linux | NOTE | Sep 02 2024 |
| R-4.4-win | NOTE | Sep 02 2024 |
| R-4.4-mac | NOTE | Sep 02 2024 |
| R-4.3-win | OK | Sep 02 2024 |
| R-4.3-mac | OK | Sep 02 2024 |
Exports:.get_api_key.level_from_quantiles.make_request.nixtla_client_cross_validation_distributed.nixtla_client_cross_validation_seq.nixtla_client_detect_anomalies_distributed.nixtla_client_detect_anomalies_seq.nixtla_client_forecast_distributed.nixtla_client_forecast_seq.nixtla_client_historic_distributed.nixtla_client_historic_seq.nixtla_data_prep.partition_payload.transform_output_dates.transient_errors.validate_exogenousdate_conversioninfer_frequencynixtla_client_cross_validationnixtla_client_detect_anomaliesnixtla_client_forecastnixtla_client_historicnixtla_client_plotnixtla_set_api_keynixtla_validate_api_key
Dependencies:anytimeaskpassBHclicodetoolscolorspacecpp11curldigestdplyrellipsisfansifarverfuturefuture.applygenericsggplot2globalsgluegtablehttr2isobandlabelinglatticelifecyclelistenvlubridatemagrittrMASSMatrixmgcvmunsellnlmeopensslparallellypillarpkgconfigpurrrR6rappdirsRColorBrewerRcpprlangscalesstringistringrsystibbletidyrtidyselecttimechangetsibbleutf8vctrsviridisLitewithr
Anomaly Detection
Rendered fromanomaly-detection.Rmdusingknitr::rmarkdownon Sep 02 2024.Last update: 2024-07-07
Started: 2023-12-13
Cross-Validation
Rendered fromcross-validation.Rmdusingknitr::rmarkdownon Sep 02 2024.Last update: 2024-07-07
Started: 2023-12-06
Data Requirements
Rendered fromdata-requirements.Rmdusingknitr::rmarkdownon Sep 02 2024.Last update: 2024-07-07
Started: 2024-07-07
Exogenous Variables
Rendered fromexogenous-variables.Rmdusingknitr::rmarkdownon Sep 02 2024.Last update: 2024-07-07
Started: 2023-12-05
Get Started
Rendered fromget-started.Rmdusingknitr::rmarkdownon Sep 02 2024.Last update: 2024-07-07
Started: 2023-12-27
Historical Forecast
Rendered fromhistorical-forecast.Rmdusingknitr::rmarkdownon Sep 02 2024.Last update: 2024-07-07
Started: 2023-12-28
Long-Horizon Forecasting
Rendered fromlong-horizon.Rmdusingknitr::rmarkdownon Sep 02 2024.Last update: 2024-07-07
Started: 2024-07-07
Prediction Intervals
Rendered fromprediction-intervals.Rmdusingknitr::rmarkdownon Sep 02 2024.Last update: 2024-07-07
Started: 2024-07-07
Quantile Forecasts
Rendered fromquantiles.Rmdusingknitr::rmarkdownon Sep 02 2024.Last update: 2024-07-07
Started: 2024-06-18
Setting Up Your API Key
Rendered fromsetting-up-your-api-key.Rmdusingknitr::rmarkdownon Sep 02 2024.Last update: 2024-07-07
Started: 2024-07-07
Special Topics
Rendered fromspecial-topics.Rmdusingknitr::rmarkdownon Sep 02 2024.Last update: 2024-09-02
Started: 2024-07-07
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Sequential version of 'nixtla_client_historic' This is a private function of 'nixtlar' | .nixtla_client_historic_seq |
| Electricity dataset | electricity |
| Electricity dataset with exogenous variables | electricity_exo_vars |
| Future values for the electricity dataset with exogenous variables | electricity_future_exo_vars |
| Infer frequency of a data frame. | infer_frequency |
| Perform cross validation with 'TimeGPT'. | nixtla_client_cross_validation |
| Detect anomalies with 'TimeGPT' | nixtla_client_detect_anomalies |
| Generate 'TimeGPT' forecast | nixtla_client_forecast |
| Generate 'TimeGPT' forecast for the in-sample period (historical period). | nixtla_client_historic |
| Plot the output of the following nixtla_client functions: forecast, historic, anomaly_detection, and cross_validation. | nixtla_client_plot |
| Set 'API' key in global environment | nixtla_set_api_key |
| Validate 'API' key | nixtla_validate_api_key |