Skip to content

Commit

Permalink
minor corrections of the demo
Browse files Browse the repository at this point in the history
  • Loading branch information
Niklewa committed Jul 26, 2024
1 parent d937d2a commit 2eb8c54
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/guides/similarity_demo_ct.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@
"source": [
"#### How to Use `CTFipsQuery` to Ask Similarity Questions\n",
"\n",
"This notebook demonstrates how to use the `CTFipsQuery` class, which is an equivalent of `FipsQuery` but based on a census tract level rather than on a county level. All functionalities remain the same. The crucial differences are as follows:\n",
"This notebook demonstrates how to use the `CTFipsQuery` class, which is similar to `FipsQuery` but operates at the census tract level rather than the county level. All functionalities remain the same. The key differences are as follows:\n",
"\n",
"- fips numbers are longer than for counties as they have 11 digits\n",
"- the `CTFipsQuery` class accepts argument `ct_time_period` which is a string that can be: 'pre_2020' or 'post_2020'. It indicates the time period for which the data should be retrieved. The default value is 'pre_2020'. The reason is a distinct definition of Census tracts before and after 2020.\n",
"- GeoNames are not distinct, as they signify the county were the Census Tract is located, and each county consists of multiple Census Tracts.\n",
"- FIPS numbers are longer than those for counties, as they have 11 digits.\n",
"- The `CTFipsQuery` class accepts the `ct_time_period` argument, which is a string that can be either 'pre_2020' or 'post_2020'. This argument indicates the time period for which the data should be retrieved. The default value is 'pre_2020', reflecting the distinct definitions of Census tracts before and after 2020.\n",
"- GeoNames are not unique, as they represent the county where the Census Tract is located, and each county contains multiple Census Tracts.\n",
"\n",
"For more complementary guidance, visit the `similarity_demo.ipynb` notebook."
"For additional guidance, please refer to the `similarity_demo.ipynb` notebook.\n"
]
},
{
Expand Down

0 comments on commit 2eb8c54

Please sign in to comment.