Skip to content

Update README.md to reflect current overlaps.tsv output format#18

Merged
jzhang-0246 merged 3 commits intomainfrom
copilot/update-readme-file
Jan 27, 2026
Merged

Update README.md to reflect current overlaps.tsv output format#18
jzhang-0246 merged 3 commits intomainfrom
copilot/update-readme-file

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 27, 2026

FEDRANN now outputs a single overlaps.tsv file containing all overlap information, rather than separate metadata.tsv and overlaps.tsv files with index-based references.

Changes

  • Output section: Removed metadata.tsv reference, updated overlaps.tsv description to reflect it contains complete overlap data
  • overlaps.tsv example: Replaced old format (index, read_name, strand) with current format showing actual overlap records:
    query_name	query_orientation	target_name	target_orientation	neighbor_rank	distance
    c2924806-d5c6-4564-b31a-c701c0226fbc	+	7e3d8f0e-fcf0-4073-ad6b-6d742245f29b	+	1	0.6606640366100363
    
  • Column descriptions: Added documentation for query_name, query_orientation, target_name, target_orientation, neighbor_rank, and distance
  • Program flowchart: Updated OUTPUT FILES section to show only overlaps.tsv and feature_matrix.npz

The new format directly provides sequence names and orientations for each overlap pair, eliminating the need for index lookups.

Original prompt

This section details on the original issue you should resolve

<issue_title>Update README.md</issue_title>
<issue_description>Fedrann now outputs only overlaps.tsv without metadata.tsv. Below is an example:

query_name	query_orientation	target_name	target_orientation	neighbor_rank	distance
c2924806-d5c6-4564-b31a-c701c0226fbc	+	7e3d8f0e-fcf0-4073-ad6b-6d742245f29b	+	1	0.6606640366100363
c2924806-d5c6-4564-b31a-c701c0226fbc	+	dd1acbc0-f219-4701-b1eb-00b9850d3d9e	-	2	0.6690033249609217
c2924806-d5c6-4564-b31a-c701c0226fbc	+	9b58f527-6e4d-4005-92cb-4863b6d42229	+	3	0.7207873470869667
c2924806-d5c6-4564-b31a-c701c0226fbc	+	932c6e73-e5d9-4bbe-b88f-e4babfc043a1	-	4	0.7347354015555427
c2924806-d5c6-4564-b31a-c701c0226fbc	+	416c786a-11f1-487f-99cc-830a40ee1c6c	-	5	0.7421239213106542
c2924806-d5c6-4564-b31a-c701c0226fbc	+	99640d4e-d299-414c-ade3-ebe567b4d1ef	+	6	0.7520030538483087
c2924806-d5c6-4564-b31a-c701c0226fbc	+	ffdda27d-9d97-4d01-8e61-8a6e281e0f69	+	7	0.7670946853284661
c2924806-d5c6-4564-b31a-c701c0226fbc	+	2e92fbd0-4577-405f-a0c4-5123179a9e78	+	8	0.7840616303663797

Update README.md accordingly. </issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits January 27, 2026 02:50
Co-authored-by: jzhang-0246 <256519759+jzhang-0246@users.noreply.github.com>
Co-authored-by: jzhang-0246 <256519759+jzhang-0246@users.noreply.github.com>
Copilot AI changed the title [WIP] Update README.md to reflect output changes Update README.md to reflect current overlaps.tsv output format Jan 27, 2026
Copilot AI requested a review from jzhang-0246 January 27, 2026 02:51
@jzhang-0246 jzhang-0246 marked this pull request as ready for review January 27, 2026 02:58
@jzhang-0246 jzhang-0246 merged commit 66f858d into main Jan 27, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update README.md

2 participants