Conversation
Troubleshooting Guide added to enhance usability by providing fixes to common issues users may encounter using cfa-dataops.
|
is this the final PR? If it is please close out the other PRs. In the future, there should only be one PR per issue and if you add/change files it goes to the same PR, not a new one. Thanks! |
| The `dataops_catalog_init` command is automatically available after installing the `cfa.dataops` package: | ||
|
|
||
| ```bash | ||
| pip install cfa.dataops |
There was a problem hiding this comment.
this kind of pip install won't actually work because the package is only on github. It will be pip install git+https://github.com/cdcgov/cfa-dataops.git.
|
|
||
| or | ||
|
|
||
| uv add cfa.dataops |
There was a problem hiding this comment.
similar to the comment above. this will be uv add cfa-dataops @ git+<same link as above>
| ## Key directories for developers: | ||
|
|
||
| ### `datasets/` | ||
| contains TOML files defining dataset ETL pipelines, metadata, validation rules, and staging behaviours. |
There was a problem hiding this comment.
capitalize C in contains for consistency
| contains TOML files defining dataset ETL pipelines, metadata, validation rules, and staging behaviours. | ||
|
|
||
| ### `workflows/` | ||
| contains reusable Python modules or workflow scripts supporting ETL. |
There was a problem hiding this comment.
capitalize C in contains for consistency
| Load with a version filter | ||
|
|
||
| ```python | ||
| df = datacat.my_project.my_dataset.load.get_dataframe(version=">2024.12.01,<2025.08") |
There was a problem hiding this comment.
version should be version_spec
| See which version would be chosen | ||
|
|
||
| ```python | ||
| v = datacat.my_project.my_dataset.load.resolve_versions(version="latest") |
There was a problem hiding this comment.
same version_spec here
| # CFA DataOps Frequently Asked Questions (FAQ) | ||
|
|
||
| ## Purpose | ||
| This FAQ document addressess common questions about the **cfa-dataops** repository and serves as a supplementary reference to existing documentation-including the technical guides, user guides, and quick start materials-to support consistent and effective use of the repository. |
There was a problem hiding this comment.
put spaces around each of the -
| You should have access to: | ||
| - CDC network | ||
| - CFA DataOps Github | ||
| - CDC.gov repositories |
There was a problem hiding this comment.
this should be CDCgov not CDC.gov
|
|
||
| If something is missing, [email cfatools](mailto:cfatoolsteam@cdc.gov) for technical support. | ||
|
|
||
| **2. Where should I work day-to-day?** |
|
|
||
| datacat.private.scenarios.covid19vax_trends.extract() | ||
|
|
||
| datacat.private.scenarios.covid19vax_trends.transform() |
There was a problem hiding this comment.
I'm pretty sure transform() and load() need arguments (dataframes) passed in
3 participants
Created a new cfa-dataops FAQ document