README

Help

How to search

Names of tools can be typed into the search bar and the list of wrappers will filter and display all matching tools. The search bar can be cleared by deleting the text or by pressing the clear button.

How to place tools

Once the wrapper list on the left is expanded and tool in blue can be dragged to the left onto the canvas.

Once the tools has been dragged to the canvas it will turn green.

How to connect tools

To connect the tools you click on the 'first button' and will see a blue outline around the button.

Then you click on the second tool and an arrow will be drawn from button1 to button2.

How to remove tools/ connections

To remove tools or connections you simply double click on of the green buttons and an alert will apear to confirm that you want to delete the item.

Once confirmed, the tool button and any lines connected to it will be removed.

Moveing Items

The whole canvas can be panned by clicking on the white space and dragging it around.

Individual buttons can also be moved by clicking and dragging them.

Getting a Snakefile

Before you can generate your Snakefile, you will create a workflow by dragging buttons onto the canvas.

Then you will click the orange 'Generate' button at the top right of the window. An alert will pop up telling you that the data has been sent to the server. At this point the server generates the Snakefile.

Setup to Run Server

Now using ngrok to serve the webapp. To set up you need to log into ngrok and export your key to the env. The app can be launched as follows:

NGROK_AUTHTOKEN=<TOKEN> go run main.go

This will give you a link to view and interact with the webapp.

If this process does not work you may have to set up the env.

git clone https://github.com/jonathan-bravo/hci_project.git

cd hci_project

go mod init hello-ngrok

go get golang.ngrok.com/ngrok

If the go run command from above works with your NGROK_AUTHTOKEN you can safely ignore this part.

Not Yet Supported

• Importing your own snakefile

Todo

• Make the CSS prettier
• Back-query snakemake wrappers github for wrappers-get
• Add block on top of search and canvas for param input on tools
• Haveing a collapasble Snakefile canvas (like overleaf) that shows the file
  • Snakemake can be downloaded from here if desired