ncbi / SKESA

SKESA assembler
Other
111 stars 18 forks source link

Circularization undocumented #35

Open lskatz opened 1 year ago

lskatz commented 1 year ago

Could you document circularization? I see in the source code that there is some kind of logic where SKESA will add _Circ to a defline but it is unclear what those conditions are. Or even more importantly, could you add to the documentation that _Circ indicates circularization and list any caveats? Thank you!

I see it around here but it is otherwise not mentioned in the repo.

https://github.com/ncbi/SKESA/blob/v2.3.0/skesa.cpp#L150

souvorov commented 1 year ago

Please check two last paragraphs of Multi-threading chapter of the original SKESA paper (https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6172800/).

From: Lee Katz @.> Sent: Thursday, November 17, 2022 2:44 PM To: ncbi/SKESA @.> Cc: Subscribed @.***> Subject: [EXTERNAL] [ncbi/SKESA] Circularization undocumented (Issue #35)

Could you document circularization? I see in the source code that there is some kind of logic where SKESA will add _Circ to a defline but it is unclear what those conditions are. Or even more importantly, could you add to the documentation that _Circ indicates circularization and list any caveats? Thank you!

I see it around here but it is otherwise not mentioned in the repo.

https://github.com/ncbi/SKESA/blob/v2.3.0/skesa.cpp#L150https://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fncbi%2FSKESA%2Fblob%2Fv2.3.0%2Fskesa.cpp%23L150&data=05%7C01%7Csouvorov%40ncbi.nlm.nih.gov%7Ceea2830e20a74d5d7b4408dac8d415c5%7C14b77578977342d58507251ca2dc2b06%7C0%7C0%7C638043110468125134%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=ByS4f%2BqjF%2B09nVezeoAz1qfw0lFEXzmqMGlhV36%2F%2BAI%3D&reserved=0

- Reply to this email directly, view it on GitHubhttps://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fncbi%2FSKESA%2Fissues%2F35&data=05%7C01%7Csouvorov%40ncbi.nlm.nih.gov%7Ceea2830e20a74d5d7b4408dac8d415c5%7C14b77578977342d58507251ca2dc2b06%7C0%7C0%7C638043110468125134%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=GHcDnhJawpsGPpvwIpzwmzJPpXIEwL760lRJ91UlK8A%3D&reserved=0, or unsubscribehttps://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAGIEUFS65WNUJYWO6VWQXQTWI2DIHANCNFSM6AAAAAASDXSZHY&data=05%7C01%7Csouvorov%40ncbi.nlm.nih.gov%7Ceea2830e20a74d5d7b4408dac8d415c5%7C14b77578977342d58507251ca2dc2b06%7C0%7C0%7C638043110468125134%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=oNSagvF4sciUtT3dueSsES3Rh%2BdCgADaxKDrag3Rgi8%3D&reserved=0. You are receiving this because you are subscribed to this thread.Message ID: @.**@.>> CAUTION: This email originated from outside of the organization. Do not click links or open attachments unless you recognize the sender and are confident the content is safe.

lskatz commented 1 year ago

Ah thanks for noting it there and pointing me in the right direction! I feel like you're saying that the documentation for SKESA therefore lives in the publication? Is that correct?

souvorov commented 1 year ago

I'm glad it was helpful. Yes, the publication describes the method used in much more details.

From: Lee Katz @.> Sent: Friday, November 18, 2022 10:41 AM To: ncbi/SKESA @.> Cc: Souvorov, Alexander (NIH/NLM/NCBI) [E] @.>; Comment @.> Subject: [EXTERNAL] Re: [ncbi/SKESA] Circularization undocumented (Issue #35)

Ah thanks for noting it there and pointing me in the right direction! I feel like you're saying that the documentation for SKESA therefore lives in the publication? Is that correct?

- Reply to this email directly, view it on GitHubhttps://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fncbi%2FSKESA%2Fissues%2F35%23issuecomment-1320192715&data=05%7C01%7Csouvorov%40ncbi.nlm.nih.gov%7Cc198cdfdc9f84367140b08dac97b4683%7C14b77578977342d58507251ca2dc2b06%7C0%7C0%7C638043828546356587%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=95Zp2WcMrj6tT0yXn5%2BHSeF6eAypBt%2BM47RpRrhIdYo%3D&reserved=0, or unsubscribehttps://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAGIEUFUID2OOZ5M5ARM4TW3WI6PQFANCNFSM6AAAAAASDXSZHY&data=05%7C01%7Csouvorov%40ncbi.nlm.nih.gov%7Cc198cdfdc9f84367140b08dac97b4683%7C14b77578977342d58507251ca2dc2b06%7C0%7C0%7C638043828546356587%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=960Fn68Y2jdDg3LdJDb%2BZE%2Fw0ScoccSVQibHS8KVYFQ%3D&reserved=0. You are receiving this because you commented.Message ID: @.**@.>> CAUTION: This email originated from outside of the organization. Do not click links or open attachments unless you recognize the sender and are confident the content is safe.