From 68a9f303269d1c1784f4b94e3fc8d25ee8055883 Mon Sep 17 00:00:00 2001 From: Arun Isaac Date: Mon, 23 Mar 2026 23:14:34 +0000 Subject: Initial commit --- COPYING | 674 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 36 ++++ channels.scm | 25 +++ manifest.scm | 41 ++++ pggb.scm | 506 ++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 1282 insertions(+) create mode 100644 COPYING create mode 100644 README.md create mode 100644 channels.scm create mode 100644 manifest.scm create mode 100644 pggb.scm diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..b722356 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +[`pggb`](https://github.com/pangenome/pggb/) builds pangenome variation graphs from a set of input sequences. `pggb.cwl` is a port of `pggb` to the [Common Workflow Language](https://www.commonwl.org/) (CWL). + +# Features + +`pggb.cwl` offers: +- better parallelization, especially of the wfmash all-to-all alignment step and the various visualization steps +- more readable code +- reproducible +- portable across computing environments + +# How to use + +First, compile the [ccwl](https://ccwl.systemreboot.net/) sources to a CWL workflow. +``` +ccwl compile -o pggb.cwl pggb.scm +``` +Now, run the compiled CWL workflow using your preferred CWL implementation. For cwltool, the reference CWL implementation: +``` +cwltool pggb.cwl inputs.yaml +``` +[ravanan](https://forge.systemreboot.net/ravanan/) is a CWL implementation that uses [Guix](https://guix.gnu.org/) to provide robust reproducibility guarantees. To run `pggb.cwl` using ravanan: +``` +ravanan --guix-channels=channels.scm --store=store pggb.cwl inputs.yaml +``` +You may need to pass in more options based on the specifics of your computing environment. + +# Differences + +`pggb.cwl` deviates from `pggb` in the following: +- Number of haplotypes is always required. In contrast, this is optional in `pggb` if sequences follow the [PanSN-spec](https://github.com/pangenome/PanSN-spec). +- External mappers are not supported. +- `--vcf-spec` is not implemented. + +# License + +pggb.cwl is free software released under the terms of the [GNU General Public License](https://www.gnu.org/licenses/gpl.html), either version 3 of the License, or (at your option) any later version. diff --git a/channels.scm b/channels.scm new file mode 100644 index 0000000..bc0b6a3 --- /dev/null +++ b/channels.scm @@ -0,0 +1,25 @@ +(list (channel + (name 'gn-bioinformatics) + (url "https://git.genenetwork.org/guix-bioinformatics") + (commit "e292b4024739e2f3bc2a2f9335b430dceb75a654")) + (channel + (inherit %default-guix-channel) + (commit "99556e7724b3dd65e2be0dd06b7b69695c9c7901")) + (channel + (name 'guix-past) + (url "https://codeberg.org/guix-science/guix-past") + (commit "d0e01528abcf07a40981303b3e4a54edd7ffd501") + (introduction + (make-channel-introduction + "0c119db2ea86a389769f4d2b9c6f5c41c027e336" + (openpgp-fingerprint + "3CE4 6455 8A84 FDC6 9DB4 0CFB 090B 1199 3D9A EBB5")))) + (channel + (name 'guix-rust-past-crates) + (url "https://codeberg.org/guix/guix-rust-past-crates") + (commit "20997ccc759799c19709fdde729d67e470fa5bcf") + (introduction + (make-channel-introduction + "1db24ca92c28255b28076792b93d533eabb3dc6a" + (openpgp-fingerprint + "F4C2D1DF3FDEEA63D1D30776ACC66D09CA528292"))))) diff --git a/manifest.scm b/manifest.scm new file mode 100644 index 0000000..25c9de1 --- /dev/null +++ b/manifest.scm @@ -0,0 +1,41 @@ +(use-modules ((gnu packages bioinformatics) #:select (ccwl ravanan) #:prefix guix:) + ((gnu packages graphviz) #:select (graphviz)) + ((gnu packages web) #:select (jq)) + (guix git-download) + (guix packages)) + +(define ccwl + (let ((commit "a83645270da5c0ee3f494b6f0449b0611fde968a") + (revision "0")) + (package + (inherit guix:ccwl) + (name "ccwl") + (version (git-version "0.5.0" revision commit)) + (source (origin + (method git-fetch) + (uri (git-reference + (url "https://git.systemreboot.net/ccwl") + (commit commit))) + (file-name (git-file-name name version)) + (sha256 + (base32 + "0gr367hiki854dkrwbhcr55f3q8aiqvk25cldx3raqy0prd3xagw"))))))) + +(define ravanan + (let ((commit "41db9dc5ab7e14c8c0fb7d669a615c62c4008916")) + (package + (inherit guix:ravanan) + (name "ravanan") + (version "0.2.0") + (source (origin + (method git-fetch) + (uri (git-reference + (url "https://git.systemreboot.net/ravanan") + (commit commit))) + (file-name (git-file-name name version)) + (sha256 + (base32 + "0xb0568g6l4rf5zibrai5zra9afwgnjxiflik6mdqkv2hi32c7rl"))))))) + +(packages->manifest + (list ccwl ravanan jq graphviz)) diff --git a/pggb.scm b/pggb.scm new file mode 100644 index 0000000..595cb97 --- /dev/null +++ b/pggb.scm @@ -0,0 +1,506 @@ +;;; pggb.cwl --- CWL port of pggb +;;; Copyright © 2026 Arun Isaac +;;; +;;; This file is part of pggb.cwl. +;;; +;;; pggb.cwl is free software: you can redistribute it and/or modify it +;;; under the terms of the GNU General Public License as published by +;;; the Free Software Foundation, either version 3 of the License, or +;;; (at your option) any later version. +;;; +;;; pggb.cwl is distributed in the hope that it will be useful, but +;;; WITHOUT ANY WARRANTY; without even the implied warranty of +;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +;;; General Public License for more details. +;;; +;;; You should have received a copy of the GNU General Public License +;;; along with pggb.cwl. If not, see . + +;;; +;;; This is a port of pggb 0.7.4 to CWL. +;;; + +(define gzip + (command #:inputs (file #:type File) + #:run "gzip" "--to-stdout" file + #:stdout "$(inputs.file.basename).gz" + #:outputs (compressed-file #:type File + #:binding ((glob . "$(inputs.file.basename).gz"))) + #:other ((hints (SoftwareRequirement + (packages . #(((package . "gzip"))))))))) + +(define bgzip + (command #:inputs (fasta #:type File) (threads #:type int) + #:run "bgzip" ("-@" threads) "--stdout" fasta + #:outputs (compressed-fasta #:type stdout + #:other ((secondaryFiles . #(".gzi")))) + #:stdout "$(inputs.fasta.basename).gz" + #:other ((hints (ResourceRequirement + (coresMin . "$(inputs.threads)")) + (SoftwareRequirement + (packages . #(((package . "htslib"))))))))) + +(define samtools-faidx + (command #:inputs (compressed_fasta #:type File + #:stage? #t) + #:run "samtools" "faidx" "$(inputs.compressed_fasta.basename)" + #:outputs (indexed-fasta #:type File + #:binding ((glob . "$(inputs.compressed_fasta.basename)")) + #:other ((secondaryFiles . #(".fai" ".gzi")))) + #:other ((hints (SoftwareRequirement + (packages . #(((package . "samtools"))))))))) + +(define wfmash-approximate + (command #:inputs + (sequences #:type File + #:other ((secondaryFiles . #(".fai" ".gzi")))) + (number_of_haplotypes #:type int) + (segment_length #:type int) + (block_length #:type #(int null)) + (map-percent-identity #:type int) + (num-mappings-for-segment #:type int) + (no-split #:type boolean) + (sparsify_mappings #:type #(float null)) + (kmer-size #:type int) + (kmer-threshold #:type float) + (exclude-delimiter #:type string) + (hg-filter-ani-diff #:type float) + (no-merge #:type boolean) + (threads #:type int) + #:run + "wfmash" + ("--segment-length" segment_length) + ("--block-length" "$(inputs.block_length === null ? 5*inputs.segment_length : inputs.block_length)") + ("--map-pct-id" map-percent-identity) + ("--num-mappings-for-segment" num-mappings-for-segment) + ("--no-split" no-split) + ;; Set sparse mapping using giant component heuristic: we + ;; keep 10*log(n)/n mappings if this is less than 1, + ;; otherwise we keep all. + ("--sparsify-mappings" "$(inputs.sparsify_mappings === null ? Math.min(10*Math.log(inputs.number_of_haplotypes)/inputs.number_of_haplotypes, 1) : inputs.sparsify_mappings)") + ("--kmer" kmer-size) + ("--kmer-threshold" kmer-threshold) + "--skip-self" + ("--skip-prefix" exclude-delimiter) + ("--threads" threads) + "--lower-triangular" + ("--hg-filter-ani-diff" hg-filter-ani-diff) + "--approx-map" + ("--no-merge" no-merge) + sequences + #:outputs (approximate-pairwise-alignment #:type stdout) + #:stdout "$(inputs.sequences.nameroot).paf" + #:other ((hints (ResourceRequirement + (coresMin . "$(inputs.threads)")) + (SoftwareRequirement + (packages . #(((package . "wfmash"))))))))) + +(define split-pairwise-alignment + (command #:inputs (pairwise_alignment #:stage? #t) (chunks #:type int) + #:run "split_approx_mappings_in_chunks" pairwise_alignment chunks + #:outputs (pairwise-alignment-chunks #:type (array File) + #:binding ((glob . "$(inputs.pairwise_alignment.basename).chunk_*.paf"))) + #:other ((hints (SoftwareRequirement + (packages . #(((package . "wfmash"))))))))) + +(define wfmash + (command #:inputs + (sequences #:type File + #:other ((secondaryFiles . #(".fai" ".gzi")))) + (number_of_haplotypes #:type int) + (segment_length #:type int) + (block_length #:type #(int null)) + (map-percent-identity #:type int) + (num-mappings-for-segment #:type int) + (no-split #:type boolean) + (sparsify_mappings #:type #(float null)) + (kmer-size #:type int) + (kmer-threshold #:type float) + (exclude-delimiter #:type string) + (hg-filter-ani-diff #:type float) + (no-merge #:type boolean) + (input-paf #:type File) + (threads #:type int) + #:run + "wfmash" + ("--segment-length" segment_length) + ("--block-length" "$(inputs.block_length === null ? 5*inputs.segment_length : inputs.block_length)") + ("--map-pct-id" map-percent-identity) + ("--num-mappings-for-segment" num-mappings-for-segment) + ("--no-split" no-split) + ;; Set sparse mapping using giant component heuristic: we + ;; keep 10*log(n)/n mappings if this is less than 1, + ;; otherwise we keep all. + ("--sparsify-mappings" "$(inputs.sparsify_mappings === null ? Math.min(10*Math.log(inputs.number_of_haplotypes)/inputs.number_of_haplotypes, 1) : inputs.sparsify_mappings)") + ("--kmer" kmer-size) + ("--kmer-threshold" kmer-threshold) + "--skip-self" + ("--skip-prefix" exclude-delimiter) + ("--threads" threads) + "--lower-triangular" + ("--hg-filter-ani-diff" hg-filter-ani-diff) + ("--no-merge" no-merge) + ("--input-paf" input-paf) + sequences + #:outputs (pairwise-alignment #:type stdout) + #:stdout "$(inputs.sequences.nameroot).paf" + #:other ((hints (ResourceRequirement + (coresMin . "$(inputs.threads)")) + (SoftwareRequirement + (packages . #(((package . "wfmash"))))))))) + +(define seqwish + (command #:inputs + (sequences #:type File) + (pairwise-alignments #:type (array File)) + (min-match-length #:type int) + (sparse-factor #:type float) + (transclose-batch #:type string) + (threads #:type int) + #:run + "seqwish" + ("--seqs" sequences) + ("--paf-alns" (array pairwise-alignments #:separator ",")) + ("--min-match-len" min-match-length) + ("--sparse-factor" sparse-factor) + ("--transclose-batch" transclose-batch) + ("--threads" threads) + ("-g" "$(inputs.sequences.nameroot).gfa") + #:outputs (variation-graph #:type File + #:binding ((glob . "$(inputs.sequences.nameroot).gfa"))) + #:other ((hints (ResourceRequirement + (coresMin . "$(inputs.threads)")) + (SoftwareRequirement + (packages . #(((package . "seqwish"))))))))) + +(define smoothxg + (command #:inputs + (graph #:type File) + (number_of_haplotypes #:type int) + (consensus-prefix #:type string) + (map_percent_identity #:type int) + (maximum-path-jump #:type string) + (maximum-edge-jump #:type string) + (abpoa #:type boolean) + (global-poa #:type boolean) + (poa-target-lengths #:type (array string)) + (poa_params #:type string) + (poa-padding-ratio #:type float) + (poa_maximum_pad_depth #:type int) + (threads #:type int) + #:run + "smoothxg" + ("--gfa-in" graph) + ("--n-haps" number_of_haplotypes) + ("--chop-to" "100") + ("--block-id-min" "$(inputs.map_percent_identity / 100)") + ("--block-ratio-min" "0") + ("--path-jump-max" maximum-path-jump) + ("--edge-jump-max" maximum-edge-jump) + ("--poa-length-targets" (array poa-target-lengths + #:separator ",")) + ("--poa-params" "${switch (inputs.poa_params) { case \"asm5\": return \"1,19,39,3,81,1\"; case \"asm10\": return \"1,9,16,2,41,1\"; case \"asm15\": return \"1,7,11,2,33,1\"; case \"asm20\": return \"1,4,6,2,26,1\"; default: return inputs.poa_params }}") + ("--poa-padding-ratio" poa-padding-ratio) + ("--max-block-depth-adaptive-poa-padding" "$(inputs.poa_maximum_pad_depth * inputs.number_of_haplotypes)") + ("--min-block-depth-split" "0") + ("--min-block-depth-mash" "0") + ("--abpoa" abpoa) + ("--change-alignment-mode" global-poa) + ("--write-msa-in-maf-format" "$(inputs.graph.nameroot).maf") + ("--consensus-prefix" consensus-prefix) + ;; Consensus paths are temporarily disabled in pggb. + "--vanish-consensus" + ("--threads" threads) + ("--smoothed-out" "$(inputs.graph.nameroot).gfa") + #:outputs + (smoothed-graph #:type File + #:binding ((glob . "$(inputs.graph.nameroot).gfa"))) + (multiple-sequence-alignment #:type File + #:binding ((glob . "$(inputs.graph.nameroot).maf"))) + #:other ((hints (ResourceRequirement + (coresMin . "$(inputs.threads)")) + (SoftwareRequirement + (packages . #(((package . "smoothxg"))))))))) + +(define gfaffix + (command #:inputs (graph #:type File) + #:run "gfaffix" graph ("--output_refined" "$(inputs.graph.nameroot).fix.gfa") + #:stdout "$(inputs.graph.nameroot).fix.affixes.tsv" + #:outputs + (fixed-graph #:type File + #:binding ((glob . "$(inputs.graph.nameroot).fix.gfa"))) + (fix-affixes #:type stdout) + #:other ((hints (SoftwareRequirement + (packages . #(((package . "gfaffix"))))))))) + +(define odgi-build + (command #:inputs graph (threads #:type int) + ;; Unlike pggb, we preserve the graph segment IDs; we do + ;; not optimize them away using --optimize. + #:run "odgi" "build" ("-t" threads) ("--gfa" graph) ("--out" "$(inputs.graph.nameroot).og") + #:outputs (odgi-graph #:binding ((glob . "$(inputs.graph.nameroot).og"))) + #:other ((hints (SoftwareRequirement + (packages . #(((package . "odgi"))))))))) + +(define odgi-view + (command #:inputs graph + #:run "odgi" "view" "--to-gfa" ("--idx" graph) + #:stdout "$(inputs.graph.nameroot).gfa" + #:outputs (gfa-graph #:type stdout) + #:other ((hints (SoftwareRequirement + (packages . #(((package . "odgi"))))))))) + + +(define odgi-unchop + (command #:inputs graph (threads #:type int) + #:run "odgi" "unchop" ("-t" threads) ("--idx" graph) ("--out" "$(inputs.graph.nameroot).og") + #:outputs (unchopped-graph #:binding ((glob . "$(inputs.graph.nameroot).og"))) + #:other ((hints (SoftwareRequirement + (packages . #(((package . "odgi"))))))))) + +(define odgi-sort + (command #:inputs graph (threads #:type int) + #:run "odgi" "sort" ("--pipeline" "Ygs") ("-t" threads) ("--idx" graph) ("--out" "$(inputs.graph.nameroot).og") + #:outputs (sorted-graph #:binding ((glob . "$(inputs.graph.nameroot).og"))) + #:other ((hints (SoftwareRequirement + (packages . #(((package . "odgi"))))))))) + +(define odgi-stats + (command #:inputs graph + #:run "odgi" "stats" ("--idx" graph) "--multiqc" "--sum-path-nodes-distances" "--no-gap-links" "--penalize-different-orientation" "--mean-links-length" + #:stdout "$(inputs.graph.nameroot).stats.yaml" + #:outputs (stats #:type stdout) + #:other ((hints (SoftwareRequirement + (packages . #(((package . "odgi"))))))))) + +(define odgi-viz + (command #:inputs graph (width #:type int #:default 1500) (height #:type int #:default 500) (path-height #:type int #:default 10) (ignore-prefix #:type string) (white-to-black #:type boolean #:default #f) (change-darkness #:type boolean #:default #f) (color-by-mean-depth #:type boolean #:default #f) (color-by-mean-inversion-rate #:type boolean #:default #f) (compressed-mode #:type boolean #:default #f) (color-by-uncalled-bases #:type boolean #:default #f) + #:run "odgi" "viz" ("--width" width) ("--height" height) ("--ignore-prefix" ignore-prefix) ("--white-to-black" white-to-black) ("--change-darkness" change-darkness) ("--color-by-mean-depth" color-by-mean-depth) ("--color-by-mean-inversion-rate" color-by-mean-inversion-rate) ("--compressed-mode" compressed-mode) ("--color-by-uncalled-bases" color-by-uncalled-bases) ("--idx" graph) ("--out" "$(inputs.graph.nameroot).png") + #:outputs (visualization #:binding ((glob . "$(inputs.graph.nameroot).png"))) + #:other ((hints (SoftwareRequirement + (packages . #(((package . "odgi"))))))))) + +(define odgi-layout + (command #:inputs graph (threads #:type int) + #:run "odgi" "layout" ("--threads" threads) ("--idx" graph) ("--out" "$(inputs.graph.nameroot).lay") + #:outputs (layout #:binding ((glob . "$(inputs.graph.nameroot).lay"))) + #:other ((hints (SoftwareRequirement + (packages . #(((package . "odgi"))))))))) + +(define odgi-draw + (command #:inputs graph layout (height #:type int #:default 1000) (color-paths #:type boolean #:default #f) (line-width #:type int #:default 10) + #:run "odgi" "draw" ("--idx" graph) ("--coords-in" layout) ("--png" "$(inputs.graph.nameroot).png") ("--png-height" height) ("--color-paths" color-paths) ("--line-width" line-width) + #:outputs (visualization-2d #:binding ((glob . "$(inputs.graph.nameroot).png"))) + #:other ((hints (SoftwareRequirement + (packages . #(((package . "odgi"))))))))) + +(define reduce-redundancy + (workflow (graph (threads #:type int)) + (pipe (gfaffix #:graph graph) + (odgi-build #:graph fixed-graph + #:threads threads) + (odgi-unchop #:graph odgi-graph + #:threads threads) + (odgi-sort #:graph unchopped-graph + #:threads threads) + (rename #:reduced-graph sorted-graph)))) + +(define visualize + (workflow (graph (ignore-prefix #:type string)) + (tee (pipe (odgi-viz (default-visualize) + #:graph graph + #:ignore-prefix ignore-prefix) + (rename #:default-visualization visualization)) + (pipe (odgi-viz (visualize-by-nucleotide-position) + #:graph graph + #:ignore-prefix ignore-prefix + #:white-to-black #t + #:change-darkness #t) + (rename #:visualization-by-nucleotide-position visualization)) + (pipe (odgi-viz (visualize-by-mean-depth) + #:graph graph + #:ignore-prefix ignore-prefix + #:color-by-mean-depth #t) + (rename #:visualization-by-mean-depth visualization)) + (pipe (odgi-viz (visualize-by-mean-inversion-rate) + #:graph graph + #:ignore-prefix ignore-prefix + #:color-by-mean-inversion-rate #t) + (rename #:visualization-by-mean-inversion-rate visualization)) + (pipe (odgi-viz (visualize-with-compressed-mode) + #:graph graph + #:ignore-prefix ignore-prefix + #:compressed-mode #t) + (rename #:compressed-mode-visualization visualization)) + (pipe (odgi-viz (visualize-by-uncalled-bases) + #:graph graph + #:ignore-prefix ignore-prefix + #:color-by-uncalled-bases #t) + (rename #:visualization-by-uncalled-bases visualization))))) + +(define visualize-2d + (workflow (graph (threads #:type int)) + (pipe (odgi-layout #:graph graph + #:threads threads) + (tee (pipe (odgi-draw (default-visualize-2d) + #:graph graph + #:layout layout) + (rename #:default-visualization-2d visualization-2d)) + (pipe (odgi-draw (visualize-2d-with-paths) + #:graph graph + #:layout layout + #:color-paths #t + #:line-width 20) + (rename #:visualization-2d-with-paths visualization-2d)))))) + +(workflow ((sequences #:type File) + (number-of-haplotypes #:type int + #:label "number of haplotypes") + ;; wfmash + (wfmash-chunks #:type int + #:default 1 + #:label "number of jobs to split wfmash alignment into") + (segment-length #:type int + #:default 1000 + #:label "segment seed length for mapping") + (block-length #:type #(int null) + #:label "keep merged mappings supported by homologies of this total length (default: 5*segment_length)") + (map-percent-identity #:type int + #:default 90 + #:label "percent identity in the mashmap step") + (num-mappings-for-segment #:type int + #:default 1 + #:label "number of mappings to retain for each query/reference pair") + (no-split #:type boolean + #:default #f + #:label "disable splitting of input sequences during mapping") + (sparsify-mappings #:type #(float null) + #:label "keep this fraction of mappings") + (kmer-size #:type int + #:default 15 + #:label "kmer size") + (kmer-threshold #:type float + #:default 0.001 + #:label "ignore the top % most-frequent kmers") + (exclude-delimiter #:type string + #:default "#" + #:label "skip mappings when the query and target have the same prefix before the last occurrence of the given character C (default assumes PanSN-spec)") + (hg-filter-ani-diff #:type float + #:default 0.0 + #:label "filter out mappings unlikely to be this ANI less than the best mapping") + (no-merge #:type boolean + #:default #f + #:label "don't merge consecutive segment-level mappings") + ;; seqwish + (min-match-length #:type int + #:default 23 + #:label "filter exact matches below this length") + (sparse-factor #:type float + #:default 0 + #:label "sparsify input maches, keeping this fraction that minimizes a hash function") + (transclose-batch #:type string + #:default "1M" + #:label "number of base pairs to use for transitive closure batch") + ;; smoothxg + (consensus-prefix #:type string + #:default "Consensus_" + #:label "prefix of consensus path names") + (maximum-path-jump #:type string + #:default "0" + #:label "maximum path jump to include in block") + (maximum-edge-jump #:type string + #:default "0" + #:label "maximum edge jump before breaking") + (abpoa #:type boolean + #:default #f + #:label "run abPOA instead of SPOA for smoothxg") + (global-poa #:type boolean + #:default #f + #:label "run global POA alignment") + (poa-target-lengths #:type (array string) + #:default #("700" "1100") + #:label "POA target lengths; blocks are split when paths go over this length") + (poa-params #:type string + #:default "asm20" + #:label "POA score parameters") + (poa-padding-ratio #:type float + #:default 0.001 + #:label "flanking sequence length fraction to pad end of each sequence with") + (poa-maximum-pad-depth #:type int + #:default 100 + #:label "depth/haplotype at which we don't pad the POA problem") + (threads #:type int + #:label "number of threads")) + (pipe (bgzip #:fasta sequences + #:threads threads) + (samtools-faidx #:compressed_fasta compressed-fasta) + (tee (pipe (wfmash-approximate #:sequences indexed-fasta + #:number_of_haplotypes number-of-haplotypes + #:segment_length segment-length + #:block_length block-length + #:map-percent-identity map-percent-identity + #:num-mappings-for-segment num-mappings-for-segment + #:no-split no-split + #:sparsify_mappings sparsify-mappings + #:kmer-size kmer-size + #:kmer-threshold kmer-threshold + #:exclude-delimiter exclude-delimiter + #:hg-filter-ani-diff hg-filter-ani-diff + #:no-merge no-merge + #:threads threads) + (split-pairwise-alignment #:pairwise_alignment approximate-pairwise-alignment + #:chunks wfmash-chunks)) + (identity)) + (scatter (wfmash #:sequences indexed-fasta + #:number_of_haplotypes number-of-haplotypes + #:segment_length segment-length + #:block_length block-length + #:map-percent-identity map-percent-identity + #:num-mappings-for-segment num-mappings-for-segment + #:no-split no-split + #:sparsify_mappings sparsify-mappings + #:kmer-size kmer-size + #:kmer-threshold kmer-threshold + #:exclude-delimiter exclude-delimiter + #:hg-filter-ani-diff hg-filter-ani-diff + #:no-merge no-merge + #:threads threads) + #:input-paf pairwise-alignment-chunks) + (seqwish #:sequences sequences + #:pairwise-alignments pairwise-alignment + #:min-match-length min-match-length + #:sparse-factor sparse-factor + #:transclose-batch transclose-batch + #:threads threads) + (rename #:unsmoothed-pangenome variation-graph) + (tee (pipe (smoothxg #:graph unsmoothed-pangenome + #:number_of_haplotypes number-of-haplotypes + #:consensus-prefix consensus-prefix + #:map_percent_identity map-percent-identity + #:maximum-path-jump maximum-path-jump + #:maximum-edge-jump maximum-edge-jump + #:abpoa abpoa + #:global-poa global-poa + #:poa-target-lengths poa-target-lengths + #:poa_params poa-params + #:poa-padding-ratio poa-padding-ratio + #:poa_maximum_pad_depth poa-maximum-pad-depth + #:threads threads) + (reduce-redundancy #:graph smoothed-graph + #:threads threads) + (tee (pipe (odgi-stats (stats-for-graph) + #:graph reduced-graph) + (rename #:graph-stats stats)) + (visualize #:graph reduced-graph + #:ignore-prefix consensus-prefix) + (visualize-2d #:graph reduced-graph + #:threads threads) + (pipe (odgi-view #:graph reduced-graph) + (rename #:pangenome gfa-graph)))) + (pipe (odgi-build (build-unsmoothed-odgi-graph) + #:graph unsmoothed-pangenome + #:threads threads) + (odgi-stats (stats-for-unsmoothed-graph) + #:graph odgi-graph) + (rename #:unsmoothed-graph-stats stats)) + (identity)))) -- cgit 1.4.1