From 40eedee78090598059a57f4e4bcfcb1a8f946a5b Mon Sep 17 00:00:00 2001 From: gmungoc Date: Tue, 25 Oct 2016 16:21:48 +0100 Subject: [PATCH] JAL-98 javadoc added --- src/jalview/analysis/Profile.java | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/src/jalview/analysis/Profile.java b/src/jalview/analysis/Profile.java index b27da9f..d94d031 100644 --- a/src/jalview/analysis/Profile.java +++ b/src/jalview/analysis/Profile.java @@ -93,26 +93,53 @@ public class Profile return pid; } + /** + * Returns the full symbol counts for this profile + * + * @return + */ public ResidueCount getCounts() { return counts; } + /** + * Returns the number of sequences in the profile + * + * @return + */ public int getHeight() { return height; } + /** + * Returns the number of sequences in the profile which had a gap character + * (or were too short to be included in this column's profile) + * + * @return + */ public int getGapped() { return gapped; } + /** + * Returns the highest count for any symbol(s) in the profile + * + * @return + */ public int getMaxCount() { return maxCount; } + /** + * Returns the symbol (or concatenated symbols) which have the highest count + * in the profile, or an empty string if there were no symbols counted + * + * @return + */ public String getModalResidue() { return modalResidue; -- 1.7.10.2