Add a new method to get related places.#113
Merged
Spaceenter merged 2 commits intodatacommonsorg:masterfrom Jan 30, 2020
Merged
Add a new method to get related places.#113Spaceenter merged 2 commits intodatacommonsorg:masterfrom
Spaceenter merged 2 commits intodatacommonsorg:masterfrom
Conversation
pradh
reviewed
Jan 30, 2020
| 'geoId/06015', | ||
| 'geoId/06023', | ||
| ] | ||
| } |
Contributor
Author
There was a problem hiding this comment.
The examples just show the format -- the result would change as we change algorithms to compute relatedness.
pradh
approved these changes
Jan 30, 2020
Contributor
pradh
left a comment
There was a problem hiding this comment.
Need to update http://docs.datacommons.org/api/python/population.html?
shifucun
reviewed
Jan 30, 2020
| """ Returns :obj:`Place`s related to :code:`dcids` for the given constraints. | ||
|
|
||
| Args: | ||
| dcids (:obj:`iterable` of :obj:`str`): Dcids to get contained in places. |
|
|
||
|
|
||
| def get_related_places(dcids, population_type, constraining_properties={}, | ||
| measured_prop='count', |
| :obj:`StatisticalPopulation` should be constrained by. | ||
| measured_property (:obj:`str`): The measured property. | ||
| stat_type (:obj:`str`): The statistical type for the observation. | ||
| within_place(:obj:`str`): Optional, the place that all the related places |
| `PerCapita` when compute the relatedness. | ||
| same_place_type(:obj:`bool`): Optional, whether to require all the | ||
| related places under the same ancestor place. | ||
|
|
| Specifying the :code:`dcids` as a :obj:`list` result in the following. | ||
|
|
||
| >>> get_places_in(["geoId/06"], "Person", { | ||
| "age": "Years21To64", |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.