Skip to content

Commit

Permalink
test out README rendering
Browse files Browse the repository at this point in the history
  • Loading branch information
@AFg6K7h4fhy2
AFg6K7h4fhy2 committed Nov 25, 2024
1 parent db1688e commit b89576b
Showing 1 changed file with 7 additions and 22 deletions.
29 changes: 7 additions & 22 deletions README.qmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down

0 comments on commit b89576b

Please sign in to comment.