AllenInstitute / AllenInstitute/ConnectsCommonConnectivity
Update README
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Jupyter Notebook
- Stars
- 4
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Problem: README predates the v1dd-ingest work and the write-mode changes.
Fix: document read API (DatasetReader, read_synapse_table), write modes (merge/overwrite/bulk/wide), config, and current schema coverage.
Blocked by: #13.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
After #13 is resolved, start in README and compare it with the current v1dd-ingest and write-mode behavior. Document the read API, write modes, configuration, and current schema coverage; the work is done when the README reflects all four areas.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100