NaegleLab / CoDIAC

Other
0 stars 0 forks source link

Write documentation/help for PDB metadata file #22

Closed knaegle closed 4 months ago

knaegle commented 1 year ago

Is your feature request related to a problem? Please describe. It is not very easy to understand the PDB metadata file fields, both before and after integration. It would be great to produce a readme that clearly describes these fields and how to interpret what they mean.

Describe the solution you'd like Produce a readme.md file about the column names, what they mean, how to use them and or how they were used in annotation.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Tasks

Include specific tasks in the order they need to be done in. Include links to specific lines of code where the task should happen at.