changeset 28:7710e44f432a

fixed some documentation and commenting

--- a/phase2/treeLinkFeatures.m	Sun Mar 12 19:56:52 2017 +0000
+++ b/phase2/treeLinkFeatures.m	Sun Mar 12 20:08:29 2017 +0000
@@ -1,9 +1,22 @@
 function [linkList, featureList]= treeLinkFeatures(data, depthThresh, featureNames)
-%% linkList = treeLinkFeatures(data)
+%% [linkList, featureList]= treeLinkFeatures(data, depthThresh, featureNames)
 % given a dataset, a hierarchical cluster of the data is produced, and then
 % the data is traversed, such that, for each split in the data, a set of
 % features are produced, which are the ranked features that can be used to
 % separate the given dataset at that point.
+% data is the nxm matrix of content, n is the number of samples and m is
+% the number of features.
+% depthThresh is a list of the range of tree depths to traverse from the
+% aglomerative clustering tree. A single value of depthThresh, will assume
+% 1:depthThresh. For analysis of a single layer of the tree, pass a list of
+% two values, both of which are the layer to be analysed.
+% feature names is the list of features, so that grown trees have suitable
+% names. No feature names will result in the feature number being returned.
+% featureList corresponds to the rows in linkList, with the form column 1
+% is the 5 most relevant features, column 2 is the depth and column 3 is a
+% decision classification tree for the decision - perhaps this should be in
+% the form of a struct instead?
+
 
 
 if(nargin < 3)