Package: nixtlar 0.6.2
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.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://cran.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 1 days agofrom:3f215a20fd. Checks:OK: 2. Indexed: no.
Target | Result | Date |
---|---|---|
Doc / Vignettes | OK | Oct 29 2024 |
R-4.5-linux | OK | Oct 29 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.Rmd
usingknitr::rmarkdown
on Oct 29 2024.Last update: 2024-10-28
Started: 2024-06-02
TimeGEN-1 Quickstart (Azure)
Rendered fromazure-quickstart.Rmd
usingknitr::rmarkdown
on Oct 29 2024.Last update: 2024-10-28
Started: 2024-10-28
Cross-Validation
Rendered fromcross-validation.Rmd
usingknitr::rmarkdown
on Oct 29 2024.Last update: 2024-10-28
Started: 2024-06-02
Data Requirements
Rendered fromdata-requirements.Rmd
usingknitr::rmarkdown
on Oct 29 2024.Last update: 2024-10-28
Started: 2024-10-10
Exogenous Variables
Rendered fromexogenous-variables.Rmd
usingknitr::rmarkdown
on Oct 29 2024.Last update: 2024-10-28
Started: 2024-06-02
Get Started
Rendered fromget-started.Rmd
usingknitr::rmarkdown
on Oct 29 2024.Last update: 2024-10-28
Started: 2024-06-02
Historical Forecast
Rendered fromhistorical-forecast.Rmd
usingknitr::rmarkdown
on Oct 29 2024.Last update: 2024-10-28
Started: 2024-06-02
Long-Horizon Forecasting
Rendered fromlong-horizon.Rmd
usingknitr::rmarkdown
on Oct 29 2024.Last update: 2024-10-28
Started: 2024-10-10
Prediction Intervals
Rendered fromprediction-intervals.Rmd
usingknitr::rmarkdown
on Oct 29 2024.Last update: 2024-10-28
Started: 2024-10-10
Quantile Forecasts
Rendered fromquantiles.Rmd
usingknitr::rmarkdown
on Oct 29 2024.Last update: 2024-10-28
Started: 2024-10-10
Setting Up Your API Key
Rendered fromsetting-up-your-api-key.Rmd
usingknitr::rmarkdown
on Oct 29 2024.Last update: 2024-10-28
Started: 2024-10-10
Special Topics
Rendered fromspecial-topics.Rmd
usingknitr::rmarkdown
on Oct 29 2024.Last update: 2024-10-28
Started: 2024-10-10
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 |