Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve user interface #117

Merged
merged 13 commits into from
Oct 21, 2024
Merged

Improve user interface #117

merged 13 commits into from
Oct 21, 2024

Conversation

vedran-kasalica
Copy link
Member

@vedran-kasalica vedran-kasalica commented Sep 25, 2024

This PR refactors parts of the codebase, improving the bio.tools API, which is now exposed at the CLI level. Users can generate APE annotations directly from bio.tools. Additionally, it introduces two new constraint templates that proved useful in generating workflows within the Workflomics project. Finally, I simplified the GitHub templates to lower the threshold for creating PRs and Issues.

Key updates:

  • Update lib to Java 17, from Java 8
  • Improved APE documentation
  • Refactored bio.tools API
  • Exposed bio.tools API at the CLI level
  • Added two constraint templates for workflow generation
  • Simplified PR and Issue templates

On a technical side, the constraint templates are explicitly encoded in CNF, unlike parsed SLTLx formulas. The plan is to start using logical constructs when defining the templates as well, but I didn't get a chance to do that yet. For the reference, the logical constructs were introduced with v2.0.

@vedran-kasalica vedran-kasalica force-pushed the biotools-api branch 3 times, most recently from 20a601e to 8acc9f8 Compare September 25, 2024 11:18
@vedran-kasalica
Copy link
Member Author

Hi @eladrion, this is the PR I was talking about, please feel free to leave any comments or questions. Thanks!

@eladrion
Copy link

Hi @vedran-kasalica , I took a brief look on the PR, see my comments above.

Best, Mario

@vedran-kasalica
Copy link
Member Author

Hi @vedran-kasalica , I took a brief look on the PR, see my comments above.

Best, Mario

Thank you Mario, I had a quick look and you left quite detailed and relevant comments! I will come back to them later this week

throw new NullPointerException("File or content set cannot be null.");
}

try (BufferedWriter writer = new BufferedWriter(
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The writer is instantiated in this method, appendToFile (base case) and appendToFile (CNFClause case) identically. Just an idea: If you implement a function which opens the file (if it exists and excepts otherwise) and writes a list of strings in append mode to the file, you could reuse that function and restrict the current functions to checking whether the encoding/content is non-null. Also, the current functions would have to provide a list of strings to the new function.

Copy link

@eladrion eladrion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything fine now, can be integrated

@vedran-kasalica vedran-kasalica merged commit 50a5222 into main Oct 21, 2024
1 check passed
@vedran-kasalica vedran-kasalica deleted the biotools-api branch October 21, 2024 09:38
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.

2 participants