From b89576bbef3fd3050ed9a0585b00a386c69def99 Mon Sep 17 00:00:00 2001 From: AFg6K7h4fhy2 <127630341+AFg6K7h4fhy2@users.noreply.github.com> Date: Mon, 25 Nov 2024 15:06:36 -0500 Subject: [PATCH] test out README rendering --- README.qmd | 29 +++++++---------------------- 1 file changed, 7 insertions(+), 22 deletions(-) diff --git a/README.qmd b/README.qmd index 7cbc865..bddcc5b 100644 --- a/README.qmd +++ b/README.qmd @@ -37,34 +37,19 @@ pip3 install git+https://github.com/CDCgov/forecasttools-py@main # Datasets +```{python} +import forecasttools +``` + `forecasttools` contains several datasets. These datasets aid with experimentation or are directly necessary to some of `forecasttools` utilities. ## Location Table The location table contains abbreviations, codes, and extended names for the US jurisdictions for which the FluSight and COVID forecasting hubs require users to generate forecasts. -Shape: (58, 3) - -| location_code | short_name | long_name | -| --- | --- | --- | -| str | str | str | -|---------------|------------|-----------------------------| -| US | US | United States | -| 1 | AL | Alabama | -| 2 | AK | Alaska | -| 4 | AZ | Arizona | -| 5 | AR | Arkansas | -| 6 | CA | California | -| 8 | CO | Colorado | -| 9 | CT | Connecticut | -| … | … | … | -| 56 | WY | Wyoming | -| 60 | AS | American Samoa | -| 66 | GU | Guam | -| 69 | MP | Northern Mariana Islands | -| 72 | PR | Puerto Rico | -| 74 | UM | U.S. Minor Outlying Islands | -| 78 | VI | U.S. Virgin Islands | +```{python} +forecasttools.location_table +``` The location table is stored in `forecasttools` as a `polars` dataframe and is accessed via: