Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

798 convert pivoted to standard shape when loading dataframe #903

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

798 convert pivoted to standard shape when loading dataframe #903

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
09bae73
final changes needed
Oct 9, 2023
17b46ef
some clean up needed
Oct 18, 2023
09f39be
step implementation misssing for behaviour tests
Oct 20, 2023
d3596f6
Merge branch 'main' into 798_Convert_pivoted_to_standard_shape_when-_…
Oct 20, 2023
5144c54
updating dependencies
Oct 20, 2023
16a6753
changed observation value column name
Oct 23, 2023
f71f4f0
fixing file exists in unit tests
Oct 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/inspect-api-dereferencing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ note: this document is temporarily being placed in the root docs folder while th

## The get_dataframe function

This `get_dataframe` function is used to get a pandas DataFrame from the CSV URL from the currently loaded data cube. It is part of the `DataCubeInspector` class, and is used by providing a `csv_url` as well as setting the `dereference_uris` parameter. It is set to `True` by default. This means the column values of the input CSV will be altered to contain their human readable labels rather than the fragment of the URI.
This `get_dataframe` function is used to get a pandas DataFrame from the CSV URL from the currently loaded data cube. It is part of the `DataCubeRepository` class, and is used by providing a `csv_url` as well as setting the `dereference_uris` parameter. It is set to `True` by default. This means the column values of the input CSV will be altered to contain their human readable labels rather than the fragment of the URI.

The example below shows the get_dataframe function being used on a CSV input from a cube that contains locally defined code lists, attribute resource values, multiple units and multiple measures.

Expand All @@ -18,7 +18,7 @@ Here is the example data set:
| something-2 | something-else-2 | 2022 | provisional | -80 | some-unit-2 | some-measure-2 | 227 |
| something-3 | something-else-3 | 2023 | estimated | -70 | some-unit-3 | some-measure-3 | 327 |

Assuming the CSV URL that is to be used as input has been assigned to a variable called `csv_url`, and that a `DataCubeInspector` object exists, the `get_dataframe` function can be used with the `dereference_uris` parameter set to `True` like so:
Assuming the CSV URL that is to be used as input has been assigned to a variable called `csv_url`, and that a `DataCubeRepository` object exists, the `get_dataframe` function can be used with the `dereference_uris` parameter set to `True` like so:

```python
dataframe, validation_errors = data_cube_inspector.get_dataframe(
Expand Down
Loading