Package: nixtlar 0.6.2
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.6.2.tar.gz
nixtlar_0.6.2.zip(r-4.5)nixtlar_0.6.2.zip(r-4.4)nixtlar_0.6.2.zip(r-4.3)
nixtlar_0.6.2.tgz(r-4.4-any)nixtlar_0.6.2.tgz(r-4.3-any)
nixtlar_0.6.2.tar.gz(r-4.5-noble)nixtlar_0.6.2.tar.gz(r-4.4-noble)
nixtlar_0.6.2.tgz(r-4.4-emscripten)nixtlar_0.6.2.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 23 days agofrom:fb582fdb50. Checks:OK: 7. Indexed: yes.
| Target | Result | Date |
|---|---|---|
| Doc / Vignettes | OK | Oct 28 2024 |
| R-4.5-win | OK | Oct 28 2024 |
| R-4.5-linux | OK | Oct 28 2024 |
| R-4.4-win | OK | Oct 28 2024 |
| R-4.4-mac | OK | Oct 28 2024 |
| R-4.3-win | OK | Oct 28 2024 |
| R-4.3-mac | OK | Oct 28 2024 |
Exports:.generate_output_dates.get_client_steup.get_model_params.level_from_quantiles.make_request.r_frequency.transient_errors.validate_exogenousinfer_frequencynixtla_client_cross_validationnixtla_client_detect_anomaliesnixtla_client_forecastnixtla_client_historicnixtla_client_plotnixtla_client_setupnixtla_set_api_keynixtla_validate_api_key
Dependencies:askpassclicodetoolscolorspacecpp11curldigestdplyrfansifarverfuturefuture.applygenericsggplot2globalsgluegtablehttr2isobandlabelinglatticelifecyclelistenvlubridatemagrittrMASSMatrixmgcvmunsellnlmeopensslparallellypillarpkgconfigpurrrR6rappdirsRColorBrewerrlangscalesstringistringrsystibbletidyrtidyselecttimechangeutf8vctrsviridisLitewithr
Anomaly Detection
Rendered fromanomaly-detection.Rmdusingknitr::rmarkdownon Oct 28 2024.Last update: 2024-10-25
Started: 2023-12-13
TimeGEN-1 Quickstart (Azure)
Rendered fromazure-quickstart.Rmdusingknitr::rmarkdownon Oct 28 2024.Last update: 2024-10-28
Started: 2024-10-25
Cross-Validation
Rendered fromcross-validation.Rmdusingknitr::rmarkdownon Oct 28 2024.Last update: 2024-10-25
Started: 2023-12-06
Data Requirements
Rendered fromdata-requirements.Rmdusingknitr::rmarkdownon Oct 28 2024.Last update: 2024-10-25
Started: 2024-07-07
Exogenous Variables
Rendered fromexogenous-variables.Rmdusingknitr::rmarkdownon Oct 28 2024.Last update: 2024-10-25
Started: 2023-12-05
Get Started
Rendered fromget-started.Rmdusingknitr::rmarkdownon Oct 28 2024.Last update: 2024-10-28
Started: 2023-12-27
Historical Forecast
Rendered fromhistorical-forecast.Rmdusingknitr::rmarkdownon Oct 28 2024.Last update: 2024-10-25
Started: 2023-12-28
Long-Horizon Forecasting
Rendered fromlong-horizon.Rmdusingknitr::rmarkdownon Oct 28 2024.Last update: 2024-10-25
Started: 2024-07-07
Prediction Intervals
Rendered fromprediction-intervals.Rmdusingknitr::rmarkdownon Oct 28 2024.Last update: 2024-10-25
Started: 2024-07-07
Quantile Forecasts
Rendered fromquantiles.Rmdusingknitr::rmarkdownon Oct 28 2024.Last update: 2024-10-25
Started: 2024-06-18
Setting Up Your API Key
Rendered fromsetting-up-your-api-key.Rmdusingknitr::rmarkdownon Oct 28 2024.Last update: 2024-10-25
Started: 2024-07-07
Special Topics
Rendered fromspecial-topics.Rmdusingknitr::rmarkdownon Oct 28 2024.Last update: 2024-10-25
Started: 2024-07-07
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| 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 |
| Sequential version of 'nixtla_client_historic' This is a private function of 'nixtlar' | nixtla_client_historic |
| Plot the output of the following nixtla_client functions: forecast, historic, anomaly_detection, and cross_validation. | nixtla_client_plot |
| Set base 'ULR' and 'API' key in global environment | nixtla_client_setup |
| Set 'API' key in global environment | nixtla_set_api_key |
| Validate 'API' key | nixtla_validate_api_key |
