Uploaded image for project: 'Jalview'
  1. Jalview
  2. JAL-2217

Rationalise namespace for accessing Jalview functions from Groovy

    XMLWordPrintable

    Details

    • Type: Epic
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Dev and Dep, Scriptable API
    • Labels:
      None
    • Epic Name:
      groovyJalviewAPI
    • Urgency:
      Not urgent

      Description

      Groovy scripts in jalview are initialised with a small number of bound objects:

      - Jalview: the jalview.bin.Jalview instance - supports getAlignFrames() and getCurrentAlFrame()
      - currentAlFrame: the first alignment frame instantiated after parsing command line arguments when running in headless mode.

      Every other aspect of Jalview is accessed via its java namespace, which makes it cumbersome to script, and means that scripters have no idea whether their code is guaranteed to run on some future version of Jalview.

      Key needs:
      * short, memorable symbols for accessing key Jalview objects (e.g. alignment, dataset, view, views, tree, trees, structureview, etc).

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              jprocter James Procter
              Reporter:
              jprocter James Procter
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated: