FireCloud is now powered by Terra! -- STARTING MAY 1st, 2019 THIS WEBPAGE WILL NO LONGER BE UPDATED.
From now on, please visit the Terra Help Center for documentation, tutorials, roadmap and feature announcements.
Want to talk to a human? Email the helpdesk, post feature requests or chat with peers in the community forum.
FIRECLOUD | Doc #10862 | (howto) Create a new method

(howto) Create a new method
Tutorials | Created 2017-12-01 | Last updated 2018-05-04


Comments (0)

Using the web interface

  1. Within the Method Repository, click on the Create New method... button

  2. Upon creation, you will be prompted to enter the following information:

    • Namespace: the "folder" where you want to store this method. Frequently analysts use their name, lab name, or institution name. Read more about namespaces here.
    • Name: the desired name of this method
    • Synopsis (optional): a description of this method
    • Documentation (optional): any markdown formatted text that you want to add to describe this method. You can put copyright information here, versions of software/tools used in the Docker image, or any details that are important.
  3. Copy/paste your WDL into the WDL text block or click "Load from file..." to load a WDL file from your computer.

  4. Snapshot comment (optional): add notes about what changes were made between snapshots here (like git commits)

Using the Command Line interface

The FireCloud Command Line Interface (CLI) provides another option to upload methods (WDL) to the Method Repository.

  1. Download the FireCloud Command Line Interface. You can also run a Docker version without downloading to your local environment.

  2. Enter cd firecloud-cli in your Terminal to change directories.

  3. Enter the FireCloud CLI push command. The box below shows an example of a command you use to push a method. firecloud -u [https://api.firecloud.org/api](https://api.firecloud.org/api) -m push -t Workflow -s broad-firecloud-jn-test -n test-method -y 'Test synopsis' file.wdl

  4. You will see a "Successfully pushed" message indicating your method uploaded to FireCloud. You can also confirm your Method pushed by viewing the Method Repository. If your push failed, you will see an error message. To troubleshoot, please share the error message in the Forum.

Description of CLI Commands

  • Enter -u, then state the URL of the FireCloud environment.

  • Enter -m, then state the command (push).

  • Enter -t, then state Workflow as the type for pushing your Method.

  • Enter -s, then state the Method Namespace.

  • Enter -n, then state the Method name.

  • Enter -y, then describe your Method

  • Finally, enter the file name for your WDL.

Return to top Comment on this article