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

New attributes to Tool model to support tool-based interface #264

Closed
prioux opened this issue Nov 19, 2015 · 1 comment
Closed

New attributes to Tool model to support tool-based interface #264

prioux opened this issue Nov 19, 2015 · 1 comment

Comments

@prioux
Copy link
Member

prioux commented Nov 19, 2015

As we move towards an interface promoting the selection of Tools as the first step to launching tasks, we'll need to categorize the tools and display them in nicely named sets and subsets within the interface.

After talking to Ehsan, and seeing the prototype tool selection panel he created, it seems Tools can be presented in three groups:

  • by software package (e.g. 'MINC', or 'FSL' or any other label to encompass software suites with many tools)
  • by type (e.g. 'file conversion', 'fMRI', 'Diffusion' or other labels describing a general type of software)
  • by arbitrary keywords (e.g. 'MIT', 'Oxford', 'Animal', 'Plant', 'TCP/IP', 'Crypto'... etc.)

To support all three groups, we'll add three attributes to the Tool model:

  • application_package_name : a single string
  • application_type : also a single string
  • application_tags : a single string containing many keywords, separated by white spaces

The Tool model can be extended to include utility methods to get all these values in a cleaner format than just the standard attribute readers and writers. For instance, I suggest overriding:

  • Tool#application_tags so that it properly splits on \W
  • Tool#application_tags= so that it handles arrays or strings, and split by \W while reinserting a single space before writing back to the DB.

Note that this is issue is complementary to issue #72 such that once both are implemented, a CbrainTask programmer will be able to directly suggest values for all three attributes, which the admin can accept as is or change any way he/she wants when a Tool object is created or edited.

@eafkhami
Copy link
Contributor

We're going to make the application_tags be delimited on commas "," rather than white spaces. This is because somebody may want to specify a tag with spaces in the tag

@prioux prioux closed this as completed Jan 13, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants