Streamlining the RosettaScripts Interface: SimpleMetrics in protocols

~ contributed by Dr. Rocco Moretti

SimpleMetrics in protocols

By Dr. Rocco Moretti, Associate Professor, Meiler Lab, Vanderbilt


SimpleMetrics are a flexible way to perform analysis on your structures. They are a much cleaner way of performing such an analysis when compared to the previous approach of commandeering the reporting functionality of RosettaScripts Filters. However, the initial implementation required that any SimpleMetric be accessed through the RunSimpleMetrics mover. This meant that using SimpleMetrics was sometimes more laborious than using an equivalent Filter, due to Filters being accessible directly from the PROTOCOLS section of the RosettaScripts XML.

To make SimpleMetrics easier to use, a `metrics` attribute was added to the `Add` tags in the PROTOCOLS section. This way, adding a SimpleMetric report as a stage in the protocol is as easy as adding an additional Mover or Filter. One consideration in this implementation is how to determine the name under which the reported metric appears in the scorefile. The RunSimpleMetrics mover has a multi-featured ability to control how the metrics are named. In line with the simplified specification, a simplified naming approach was taken. By default, the scorefile header name is simply the same as the `name` attribute of the SimpleMetric itself (that is, the same name you pass to the `metrics` attribute to identify which SimpleMetric to use). However, to accommodate the common use case of applying a single SimpleMetric multiple times at different points in the protocol, a `labels` attribute is also provided, allowing you to specify, for example, both `pre_relax_energy` and `post_relax_energy` with the same SimpleMetrics object.  For full flexibility and backwards compatibility, both the RunSimpleMetrics mover and the streamlined implementations are available for use.


(Stay tuned for the next blog on this topic: RosettaScripts Type-hinting in VS Code By Dr. Vikram Mulligan)

Popular posts from this blog

Introducing Rosetta Commons Foundation and Levitate Bio

Dear members of the Rosetta Community, The Rosetta Commons Board is excited to announce a significant milestone in the evolution of our community and a step on our path toward the Future of Rosetta. We have created a non-profit organization, the Rosetta Commons Foundation, which has established a wholly-owned subsidiary company called Levitate Bio. Levitate Bio provides cloud-based automated protein modeling and design protocols using AI & Rosetta, available through annual subscriptions. With a mission similar to the Rosetta Commons, the Rosetta Commons Foundation aims to foster a collaborative community that contributes to knowledge and tools for computational modeling and design of biological macromolecules. Appointed by the Rosetta Commons Board, the Foundation’s initial Board currently consists of Jeff Gray, Julia Koehler Leman, and David Nannemann. We expect this leadership structure to evolve soon, with a more permanent Board structure announced in due course. What is unique...
Read more

Announcing the winners of the Winter Protein Design Games 2024: Unleashing Innovation in Enzyme Engineering

Image
The Winter RosettaCon organizers want to thank Liberum Bio for sponsoring the experimental validation of the designs that they carried out in 8 days starting from digital sequences! Liberum Bio produces proteins at high yields in cell-free systems at a fraction of the usual cost and time via highly engineered strains and state-of-the art reaction mixtures. At Winter RosettaCon 2024 in Boston, the Rosetta Commons in partnership with Liberum Biotech hosted the inaugural Winter Protein Design Games , focusing on the design of Tobacco Etch Virus (TEV) protease variants. TEV protease is commonly used as a tool for sequence-specific protein cleavage, facilitating the purification of proteins without affinity tags. The competition challenged cross-institutional participating teams to engineer TEV proteases that exhibited enhanced substrate cleavage efficiency over the wild-type enzyme.  The competition was straightforward: design TEV protease variants that outperform the wild type in cl...
Read more

Announcing Rosetta's Transition to a Public Repository (including Licensing Changes)

Dear Rosetta Community and users of Rosetta, We're excited to announce that we have moved the Rosetta code repository to a public repository! We have made this move to honor our longstanding philosophy of sharing our work publicly and making it broadly accessible to scientists. This change marks a new chapter for Rosetta, where future developments will be more collaborative and accessible.  This move required crucial changes to our workflow and licensing terms that are designed to streamline contributions to our platform. The new repository is accessible at https://github.com/RosettaCommons/rosetta . Licensing adjustments: The repository's public status means that non-commercial users no longer need to explicitly sign up for a license to access Rosetta. However, despite being publicly accessible, Rosetta is not open source; redistribution restrictions and other licensing restrictions remain in place for all users. For our commercial users, the existing license will continue as...
Read more