{
"_id": "6a156920acfb0bcc41d627f0",
"Package": "nixtlar",
"Title": "A Software Development Kit for 'Nixtla''s 'TimeGPT'",
"Version": "0.6.4",
"Authors@R": "c(\nperson(\"Mariana\", \"Menchero\", email = \"mariana@nixtla.io\", role = c(\"aut\", \"cre\"), comment = \"First author and maintainer\"),\nperson(\"Nixtla\", role = \"cph\", comment = \"Copyright held by 'Nixtla'\")\n)",
"Description": "A Software Development Kit for working with 'Nixtla''s\n'TimeGPT', a foundation model for time series forecasting.\n'API' is an acronym for 'application programming interface';\nthis package allows users to interact with 'TimeGPT' via the\n'API'. You can set and validate 'API' keys and generate\nforecasts via 'API' calls. It is compatible with 'tsibble' and\nbase R. For more details visit .",
"License": "Apache License (>= 2.0)",
"Encoding": "UTF-8",
"Roxygen": "list(markdown = TRUE)",
"RoxygenNote": "7.3.2",
"LazyData": "true",
"Config/testthat/edition": "3",
"URL": "https://nixtla.github.io/nixtlar/, https://docs.nixtla.io/,\nhttps://github.com/Nixtla/nixtlar",
"VignetteBuilder": "knitr",
"BugReports": "https://github.com/Nixtla/nixtlar/issues",
"Config/pak/sysreqs": "libicu-dev libssl-dev",
"Repository": "https://nixtla.r-universe.dev",
"Date/Publication": "2025-02-17 05:56:22 UTC",
"RemoteUrl": "https://github.com/nixtla/nixtlar",
"RemoteRef": "HEAD",
"RemoteSha": "6d48eb86068e7cafae532d802d5a14fddc31e979",
"NeedsCompilation": "no",
"Packaged": {
"Date": "2026-05-26 09:30:36 UTC",
"User": "root"
},
"Author": "Mariana Menchero [aut, cre] (First author and maintainer),\nNixtla [cph] (Copyright held by 'Nixtla')",
"Maintainer": "Mariana Menchero ",
"MD5sum": "503dc54d00c37ded3073ca9b4e9f3b67",
"_user": "nixtla",
"_type": "src",
"_file": "nixtlar_0.6.4.tar.gz",
"_fileid": "79f27f996e6f8aa8c4c00933dd9443c8b29f1c4ce1081b77195e2ed42bf86d3e",
"_filesize": 4660871,
"_sha256": "79f27f996e6f8aa8c4c00933dd9443c8b29f1c4ce1081b77195e2ed42bf86d3e",
"_created": "2026-05-26T09:30:36.000Z",
"_published": "2026-05-26T09:34:24.687Z",
"_distro": "noble",
"_jobs": [
{
"job": 77846203653,
"time": 157,
"config": "linux-devel-x86_64",
"r": "4.7.0",
"check": "OK",
"artifact": "7213615197"
},
{
"job": 77846203619,
"time": 148,
"config": "linux-release-x86_64",
"r": "4.6.0",
"check": "OK",
"artifact": "7213611957"
},
{
"job": 77846203649,
"time": 193,
"config": "macos-oldrel-arm64",
"r": "4.5.3",
"check": "OK",
"artifact": "7213618604"
},
{
"job": 77846203625,
"time": 176,
"config": "macos-release-arm64",
"r": "4.6.0",
"check": "OK",
"artifact": "7213611414"
},
{
"job": 77845536035,
"time": 235,
"config": "source",
"r": "4.6.0",
"check": "OK",
"artifact": "7213559596"
},
{
"job": 77846203624,
"time": 117,
"config": "wasm-release",
"r": "4.6.0",
"check": "OK",
"artifact": "7213601301"
},
{
"job": 77846203634,
"time": 96,
"config": "windows-devel",
"r": "4.7.0",
"check": "OK",
"artifact": "7213594178"
},
{
"job": 77846203650,
"time": 118,
"config": "windows-oldrel",
"r": "4.5.3",
"check": "OK",
"artifact": "7213601938"
},
{
"job": 77846203641,
"time": 88,
"config": "windows-release",
"r": "4.6.0",
"check": "OK",
"artifact": "7213590796"
}
],
"_buildurl": "https://github.com/r-universe/nixtla/actions/runs/26444005071",
"_status": "success",
"_host": "GitHub-Actions",
"_upstream": "https://github.com/nixtla/nixtlar",
"_commit": {
"id": "6d48eb86068e7cafae532d802d5a14fddc31e979",
"author": "Mariana Menchero García <47995617+MMenchero@users.noreply.github.com>",
"committer": "GitHub ",
"message": "Merge pull request #57 from Nixtla/hotfix/vector-length\n\nhotfix: Issue with vector length ",
"time": 1739771782
},
"_maintainer": {
"name": "Mariana Menchero",
"email": "mariana@nixtla.io",
"login": "mmenchero",
"twitter": "@mmencherogarcia",
"description": "",
"uuid": 47995617
},
"_registered": true,
"_dependencies": [
{
"package": "R",
"version": ">= 4.1.0",
"role": "Depends"
},
{
"package": "dplyr",
"role": "Imports"
},
{
"package": "future",
"role": "Imports"
},
{
"package": "future.apply",
"role": "Imports"
},
{
"package": "ggplot2",
"role": "Imports"
},
{
"package": "httr2",
"role": "Imports"
},
{
"package": "lubridate",
"role": "Imports"
},
{
"package": "purrr",
"role": "Imports"
},
{
"package": "rlang",
"role": "Imports"
},
{
"package": "tidyr",
"role": "Imports"
},
{
"package": "tidyselect",
"role": "Imports"
},
{
"package": "httptest2",
"role": "Suggests"
},
{
"package": "knitr",
"role": "Suggests"
},
{
"package": "rmarkdown",
"role": "Suggests"
},
{
"package": "testthat",
"version": ">= 3.0.0",
"role": "Suggests"
},
{
"package": "usethis",
"role": "Suggests"
}
],
"_owner": "nixtla",
"_selfowned": true,
"_usedby": 1,
"_updates": [],
"_tags": [],
"_stars": 40,
"_contributors": [
{
"user": "mmenchero",
"count": 216,
"uuid": 47995617
},
{
"user": "tracykteal",
"count": 3,
"uuid": 889238
}
],
"_userbio": {
"uuid": 79945230,
"type": "organization",
"name": "Nixtla",
"description": "Open Source Time Series Ecosystem"
},
"_downloads": {
"count": 673,
"source": "https://cranlogs.r-pkg.org/downloads/total/last-month/nixtlar"
},
"_devurl": "https://github.com/nixtla/nixtlar",
"_pkgdown": "https://nixtla.github.io/nixtlar/",
"_searchresults": 62,
"_rbuild": "4.6.0",
"_assets": [
"extra/citation.cff",
"extra/citation.html",
"extra/citation.json",
"extra/citation.txt",
"extra/contents.json",
"extra/NEWS.html",
"extra/NEWS.txt",
"extra/nixtlar.html",
"extra/readme.html",
"extra/readme.md",
"manual.pdf"
],
"_homeurl": "https://github.com/nixtla/nixtlar",
"_realowner": "nixtla",
"_cranurl": true,
"_releases": [
{
"version": "0.5.2",
"date": "2024-06-01"
},
{
"version": "0.6.1",
"date": "2024-10-10"
},
{
"version": "0.6.2",
"date": "2024-10-28"
}
],
"_exports": [
".generate_output_dates",
".get_client_steup",
".get_model_params",
".level_from_quantiles",
".make_request",
".r_frequency",
".transient_errors",
".validate_exogenous",
"infer_frequency",
"nixtla_client_cross_validation",
"nixtla_client_detect_anomalies",
"nixtla_client_forecast",
"nixtla_client_historic",
"nixtla_client_plot",
"nixtla_client_setup",
"nixtla_set_api_key",
"nixtla_validate_api_key"
],
"_datasets": [
{
"name": "electricity",
"title": "Electricity dataset",
"object": "electricity",
"class": [
"data.frame"
],
"fields": [
"unique_id",
"ds",
"y"
],
"rows": 8400,
"table": true,
"tojson": true
},
{
"name": "electricity_exo_vars",
"title": "Electricity dataset with exogenous variables",
"object": "electricity_exo_vars",
"class": [
"data.frame"
],
"fields": [
"unique_id",
"ds",
"y",
"Exogenous1",
"Exogenous2",
"day_0",
"day_1",
"day_2",
"day_3",
"day_4",
"day_5",
"day_6"
],
"rows": 8400,
"table": true,
"tojson": true
},
{
"name": "electricity_future_exo_vars",
"title": "Future values for the electricity dataset with exogenous variables",
"object": "electricity_future_exo_vars",
"class": [
"data.frame"
],
"fields": [
"unique_id",
"ds",
"Exogenous1",
"Exogenous2",
"day_0",
"day_1",
"day_2",
"day_3",
"day_4",
"day_5",
"day_6"
],
"rows": 120,
"table": true,
"tojson": true
}
],
"_help": [
{
"page": "electricity",
"title": "Electricity dataset",
"topics": [
"electricity"
]
},
{
"page": "electricity_exo_vars",
"title": "Electricity dataset with exogenous variables",
"topics": [
"electricity_exo_vars"
]
},
{
"page": "electricity_future_exo_vars",
"title": "Future values for the electricity dataset with exogenous variables",
"topics": [
"electricity_future_exo_vars"
]
},
{
"page": "infer_frequency",
"title": "Infer frequency of a data frame.",
"topics": [
"infer_frequency"
]
},
{
"page": "nixtla_client_historic",
"title": "'TimeGPT' historic forecast",
"topics": [
"nixtla_client_historic"
]
},
{
"page": "nixtla_client_plot",
"title": "Plot the output of the following nixtla_client functions: forecast, historic, anomaly_detection, and cross_validation.",
"topics": [
"nixtla_client_plot"
]
},
{
"page": "nixtla_client_setup",
"title": "Set base 'ULR' and 'API' key in global environment",
"topics": [
"nixtla_client_setup"
]
},
{
"page": "nixtla_set_api_key",
"title": "Set 'API' key in global environment",
"topics": [
"nixtla_set_api_key"
]
},
{
"page": "nixtla_validate_api_key",
"title": "Validate 'API' key",
"topics": [
"nixtla_validate_api_key"
]
}
],
"_pkglogo": "https://github.com/nixtla/nixtlar/raw/HEAD/man/figures/logo.png",
"_readme": "https://github.com/nixtla/nixtlar/raw/HEAD/README.md",
"_rundeps": [
"askpass",
"cli",
"codetools",
"cpp11",
"curl",
"digest",
"dplyr",
"farver",
"future",
"future.apply",
"generics",
"ggplot2",
"globals",
"glue",
"gtable",
"httr2",
"isoband",
"labeling",
"lifecycle",
"listenv",
"lubridate",
"magrittr",
"openssl",
"parallelly",
"pillar",
"pkgconfig",
"purrr",
"R6",
"rappdirs",
"RColorBrewer",
"rlang",
"S7",
"scales",
"stringi",
"stringr",
"sys",
"tibble",
"tidyr",
"tidyselect",
"timechange",
"utf8",
"vctrs",
"viridisLite",
"withr"
],
"_vignettes": [
{
"source": "anomaly-detection.Rmd",
"filename": "anomaly-detection.html",
"title": "Anomaly Detection",
"engine": "knitr::rmarkdown",
"headings": [
"1. Anomaly detection",
"2. Load data",
"3. Detect Anomalies",
"4. Plot anomalies"
],
"created": "2023-12-13 02:57:56",
"modified": "2024-10-25 06:27:33",
"commits": 12
},
{
"source": "cross-validation.Rmd",
"filename": "cross-validation.html",
"title": "Cross-Validation",
"engine": "knitr::rmarkdown",
"headings": [
"1. Time series cross-validation",
"2. Load data",
"3. Perform time series cross-validation",
"4. Plot cross-validation results"
],
"created": "2023-12-06 04:18:15",
"modified": "2024-10-25 06:27:33",
"commits": 17
},
{
"source": "data-requirements.Rmd",
"filename": "data-requirements.html",
"title": "Data Requirements",
"engine": "knitr::rmarkdown",
"headings": [
"1. Input Requirements",
"2. Multiple Series",
"3. Exogenous Variables",
"4. Missing values",
"5. Minimum data requirements"
],
"created": "2024-07-07 21:00:03",
"modified": "2024-10-25 06:27:33",
"commits": 4
},
{
"source": "exogenous-variables.Rmd",
"filename": "exogenous-variables.html",
"title": "Exogenous Variables",
"engine": "knitr::rmarkdown",
"headings": [
"1. Exogenous variables",
"2. Load data",
"3a. Forecasting electricity prices using historic and future exogenous variables",
"3b. Forecasting electricity prices using only historic exogenous variables",
"3c. Forecasting future exogenous variables",
"3d. Forecasting electricity prices using both future and historic exogenous variables",
"4. Plot TimeGPT forecast"
],
"created": "2023-12-05 23:06:04",
"modified": "2025-02-17 05:56:22",
"commits": 9
},
{
"source": "fine-tuning.Rmd",
"filename": "fine-tuning.html",
"title": "Fine-tuning",
"engine": "knitr::rmarkdown",
"headings": [
"1. Introduction",
"2. Fine-tuning parameters",
"3. Example",
"4. Final recommendations"
],
"created": "2024-12-19 05:02:22",
"modified": "2024-12-19 05:02:22",
"commits": 1
},
{
"source": "get-started.Rmd",
"filename": "get-started.html",
"title": "Get Started",
"engine": "knitr::rmarkdown",
"headings": [
"1. Setting up your API key",
"a. Using the nixtla_client_setup function",
"b. Using an environment variable",
"Validate your API key",
"2. Generate TimeGPT forecast",
"3. Plot TimeGPT forecast"
],
"created": "2023-12-27 21:24:08",
"modified": "2024-10-28 22:53:17",
"commits": 11
},
{
"source": "historical-forecast.Rmd",
"filename": "historical-forecast.html",
"title": "Historical Forecast",
"engine": "knitr::rmarkdown",
"headings": [
"1. TimeGPT Historical Forecast",
"2. Load data",
"3. Forecast historical data",
"3.1 Fitted values from nixtlar::nixtla_client_forecast"
],
"created": "2023-12-28 04:43:06",
"modified": "2024-10-25 06:27:33",
"commits": 10
},
{
"source": "long-horizon.Rmd",
"filename": "long-horizon.html",
"title": "Long-Horizon Forecasting",
"engine": "knitr::rmarkdown",
"headings": [
"1. Long-horizon forecasting",
"2. Load data",
"3. Forecast with a long-horizon",
"4. Plot the long-horizon forecast",
"5. Evaluate the long-horizon model"
],
"created": "2024-07-07 21:00:03",
"modified": "2024-10-25 06:27:33",
"commits": 3
},
{
"source": "prediction-intervals.Rmd",
"filename": "prediction-intervals.html",
"title": "Prediction Intervals",
"engine": "knitr::rmarkdown",
"headings": [
"1. Uncertainty quantification via prediction intervals",
"2. Load data",
"3. Forecast with prediction intervals",
"4. Plot prediction intervals"
],
"created": "2024-07-07 21:00:03",
"modified": "2024-10-25 06:27:33",
"commits": 3
},
{
"source": "quantiles.Rmd",
"filename": "quantiles.html",
"title": "Quantile Forecasts",
"engine": "knitr::rmarkdown",
"headings": [
"1. Uncertainty quantification via quantiles",
"2. Load data",
"3. Forecast with quantiles",
"4. Plot quantiles"
],
"created": "2024-06-18 02:09:53",
"modified": "2024-10-25 06:27:33",
"commits": 4
},
{
"source": "setting-up-your-api-key.Rmd",
"filename": "setting-up-your-api-key.html",
"title": "Setting Up Your API Key",
"engine": "knitr::rmarkdown",
"headings": [
"1. What is an API key?",
"2. How can I get one?",
"3. How do I set up my API key?",
"3.1 Using the nixtlar::nixtla_client_setup function",
"3.2 Using an environment variable",
"a. Using options",
"b. Using .Renviron",
"4. Validate your API key (optional)",
"5. Azure endpoints"
],
"created": "2024-07-07 21:00:03",
"modified": "2024-10-25 06:27:33",
"commits": 4
},
{
"source": "special-topics.Rmd",
"filename": "special-topics.html",
"title": "Special Topics",
"engine": "knitr::rmarkdown",
"headings": [
"Special topics",
"1. Handling missing values",
"2. Specifying the frequency of your data"
],
"created": "2024-07-07 21:00:03",
"modified": "2024-10-25 06:27:33",
"commits": 6
},
{
"source": "azure-quickstart.Rmd",
"filename": "azure-quickstart.html",
"title": "TimeGEN-1 Quickstart (Azure)",
"engine": "knitr::rmarkdown",
"headings": [
"1. Set up a TimeGEN-1 endpoint account and generate your API key on Azure.",
"2. Install nixtlar",
"3. Set up the Base URL and API key",
"4. Start making forecasts!",
"Discover the power of TimeGEN on Azure via nixtlar."
],
"created": "2024-10-25 06:27:33",
"modified": "2025-02-13 17:52:30",
"commits": 3
},
{
"source": "vn1-forecasting-competition.Rmd",
"filename": "vn1-forecasting-competition.html",
"title": "VN1 Forecasting Competition",
"engine": "knitr::rmarkdown",
"headings": [
"Introduction",
"TimeGPT 2nd Place Submission",
"Try It Yourself!",
"References"
],
"created": "2024-12-13 22:30:00",
"modified": "2024-12-13 22:30:00",
"commits": 1
}
],
"_score": 7.716670975560136,
"_indexed": true,
"_nocasepkg": "nixtlar",
"_universes": [
"nixtla",
"mmenchero"
],
"_binaries": [
{
"r": "4.7.0",
"os": "linux",
"version": "0.6.4",
"date": "2026-05-26T09:32:58.000Z",
"distro": "noble",
"commit": "6d48eb86068e7cafae532d802d5a14fddc31e979",
"fileid": "0c67254e297802ef153aee997a44ae41862e11d4c5d395639e478c81507545b9",
"status": "success",
"check": "OK",
"buildurl": "https://github.com/r-universe/nixtla/actions/runs/26444005071"
},
{
"r": "4.6.0",
"os": "linux",
"version": "0.6.4",
"date": "2026-05-26T09:32:52.000Z",
"distro": "noble",
"commit": "6d48eb86068e7cafae532d802d5a14fddc31e979",
"fileid": "4ec2880c8c574c9ec364d53cba7e860b982a99c1b21f6fb203d640ce3665b54a",
"status": "success",
"check": "OK",
"buildurl": "https://github.com/r-universe/nixtla/actions/runs/26444005071"
},
{
"r": "4.5.3",
"os": "mac",
"version": "0.6.4",
"date": "2026-05-26T09:33:10.000Z",
"commit": "6d48eb86068e7cafae532d802d5a14fddc31e979",
"fileid": "cd6c807c4040dcc320ec21030b92bccff67f27ede5e1e531f1085049d83a0c3f",
"status": "success",
"check": "OK",
"buildurl": "https://github.com/r-universe/nixtla/actions/runs/26444005071"
},
{
"r": "4.6.0",
"os": "mac",
"version": "0.6.4",
"date": "2026-05-26T09:32:54.000Z",
"commit": "6d48eb86068e7cafae532d802d5a14fddc31e979",
"fileid": "dcd6aa6e6de32e12a7e378f887b957eccf0093ddfa14893dc25ac0a73928dae3",
"status": "success",
"check": "OK",
"buildurl": "https://github.com/r-universe/nixtla/actions/runs/26444005071"
},
{
"r": "4.6.0",
"os": "wasm",
"version": "0.6.4",
"date": "2026-05-26T09:32:52.000Z",
"commit": "6d48eb86068e7cafae532d802d5a14fddc31e979",
"fileid": "c3e974854cbee22430f2cae4f31c22e84ebf9c6ad064ed3cad72ce2317b36641",
"status": "success",
"buildurl": "https://github.com/r-universe/nixtla/actions/runs/26444005071"
},
{
"r": "4.7.0",
"os": "win",
"version": "0.6.4",
"date": "2026-05-26T09:31:51.000Z",
"commit": "6d48eb86068e7cafae532d802d5a14fddc31e979",
"fileid": "082a62f2acb7e4ba3be250e100df5823b85cd7da08e7b3758f8127a44f3bfbbd",
"status": "success",
"check": "OK",
"buildurl": "https://github.com/r-universe/nixtla/actions/runs/26444005071"
},
{
"r": "4.5.3",
"os": "win",
"version": "0.6.4",
"date": "2026-05-26T09:32:10.000Z",
"commit": "6d48eb86068e7cafae532d802d5a14fddc31e979",
"fileid": "40e027b1b7149c3dd79ea088aa078883665800f8d0e74486384d53260fbff2bf",
"status": "success",
"check": "OK",
"buildurl": "https://github.com/r-universe/nixtla/actions/runs/26444005071"
},
{
"r": "4.6.0",
"os": "win",
"version": "0.6.4",
"date": "2026-05-26T09:31:53.000Z",
"commit": "6d48eb86068e7cafae532d802d5a14fddc31e979",
"fileid": "e3d991b460141d7cdf6ab14761aed85a0a5d454e94c0dfe4a95ed1d5d41cd451",
"status": "success",
"check": "OK",
"buildurl": "https://github.com/r-universe/nixtla/actions/runs/26444005071"
}
]
}