X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=examples%2Fgroovy%2FfeatureCounter.groovy;h=9059dd0def10ce7c73d4f584b186b53a411b10c8;hb=d4a9ea73ba6f86fdcb69e08529f38600db3a99fc;hp=3b5bca6e73aa4fd5b9dc81427dae275941d1d5d7;hpb=989dfdcbd007d4530dae7f0d8a64df55c7136703;p=jalview.git diff --git a/examples/groovy/featureCounter.groovy b/examples/groovy/featureCounter.groovy index 3b5bca6..9059dd0 100644 --- a/examples/groovy/featureCounter.groovy +++ b/examples/groovy/featureCounter.groovy @@ -1,3 +1,24 @@ +/* + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors + * + * This file is part of Jalview. + * + * Jalview is free software: you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation, either version 3 + * of the License, or (at your option) any later version. + * + * Jalview is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty + * of MERCHANTABILITY or FITNESS FOR A PARTICULAR + * PURPOSE. See the GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with Jalview. If not, see . + * The Jalview Authors are detailed in the 'AUTHORS' file. + */ + import jalview.workers.FeatureCounterI; import jalview.workers.AlignmentAnnotationFactory; @@ -5,11 +26,15 @@ import jalview.workers.AlignmentAnnotationFactory; * Example script that registers two alignment annotation calculators * - one that counts residues in a column with Pfam annotation * - one that counts only charged residues with Pfam annotation - * To try this, first load uniref50.fa from the examples folder, then load features - * from examples/exampleFeatures.txt, before running this script from the Groovy console. + * + * To try: + * 1. load uniref50.fa from the examples folder + * 2. load features onto it from from examples/exampleFeatures.txt + * 3. Open this script in the Groovy console. + * 4. Either execute this script from the console, or via Calculate->Run Groovy Script - * Modify this example as required to count by column any desired value that can be - * derived from the residue and sequence features at each position of an alignment. + * To explore further, try changing this script to count other kinds of occurrences of + * residue and sequence features at columns in an alignment. */ /*