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.

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

Transposed data formats documentation #725

Open
bnygren opened this issue Oct 24, 2024 · 6 comments
Open

Transposed data formats documentation #725

bnygren opened this issue Oct 24, 2024 · 6 comments
Assignees
Labels
improvement minor refinement of existing feature element on hold pending resolution of external issue, don't work on it
Milestone

Comments

@bnygren
Copy link
Collaborator

bnygren commented Oct 24, 2024

Users are a bit confused by the transposed data formats and request a data dictionary, particularly that explains the matching of columns and calculation formulas

related: #654 #707 #712

see example of structure below:

Since the whole export is really text, not sure if the format col is needed. the description would be for any new variables and would show the formula for those that are summed for example.

Commas in labels that can cause problems can be replaced with a space for use in the csv file.

variable name var name wide var label wide format new description
District District district text    
Dcode DCode dcode integer    
Cluster Cluster Cluster text    
Cluster Number Cluster Number clusternumber integer    
CCode CCode ccode integer    
Form Phase Form Phase formType text    
Source Source source text    
Creating User Creating user creatingUser text    
Day     integer Yes day of campaign index
NumberRemainingAbsent       Yes NumberRemainingAbsent_day1 + NumberRemainingAbsent_day2 + NumberRemainingAbsent_day3
FoundVaccinatedAbsentReturnDuringCampaign       Yes FoundVaccinatedAbsentReturnDuringCampaign_day1 + FoundVaccinatedAbsentReturnDuringCampaign_day2 + FoundVaccinatedAbsentReturnDuringCampaign_day3
TotalMissedDay1_3     integer Yes TotalMissedDay1_3_day1 + sum of TotalMissedDay1_3_day2 + sum of TotalMissedDay1_3_day3
@bnygren bnygren added the developer not assigned Developer is not assigned yet label Oct 24, 2024
@Eutit5 Eutit5 removed the developer not assigned Developer is not assigned yet label Oct 25, 2024
@RaziaMahmodi RaziaMahmodi added this to the 2024 11 (Nov) milestone Oct 31, 2024
@DevSeg DevSeg added pre-review Issue addressed but not yet on test for review improvement minor refinement of existing feature element and removed pre-review Issue addressed but not yet on test for review labels Nov 20, 2024
@bnygren
Copy link
Collaborator Author

bnygren commented Dec 4, 2024

Per discussion 4-Dec with @DevSeg , we agreed to replace commas in the label description string with a pace to avoid issues with the csv column positioning. Thanks

@Eutit5 Eutit5 added review Eligible for close after review of upcoming build and removed pre-review Issue addressed but not yet on test for review labels Dec 7, 2024
@bnygren
Copy link
Collaborator Author

bnygren commented Dec 10, 2024

Hi @Eutit5 I know this was moved to review but where is the documentation? Is it in the wiki somewhere? thanks

@Eutit5
Copy link
Collaborator

Eutit5 commented Dec 10, 2024

@DevSeg

@DevSeg
Copy link
Collaborator

DevSeg commented Dec 10, 2024

Hi @bnygren Do you mean the data dictionary that would be exported from the feature or do you want us to provide a wiki to address utilizing the exported documentation?

@bnygren
Copy link
Collaborator Author

bnygren commented Dec 10, 2024

Hi @DevSeg @Eutit5 I see it now. I didn't realize it was within the page itself. Thanks

@bnygren
Copy link
Collaborator Author

bnygren commented Dec 10, 2024

As this is now it seems to show the code for calculated fields, rather than explaining the fields created for the transposed export. That said I'm not sure this will be necessary. Reviewing the transposed data export field list as posted in #712, it seems the fields should be self explanatory. If we feel documentation is still necessary, the Support page may be a better location and the button for the Data Guide can then be removed.

@bnygren bnygren added pending discussion and removed review Eligible for close after review of upcoming build labels Dec 10, 2024
@bnygren bnygren added on hold pending resolution of external issue, don't work on it and removed pending discussion labels Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement minor refinement of existing feature element on hold pending resolution of external issue, don't work on it
Projects
None yet
Development

No branches or pull requests

5 participants