Skip to content

Commit

Permalink
startup.m deleted
Browse files Browse the repository at this point in the history
checkFSDAsetup.m added
downloadGraphicalOutput.m added

All html regenerated and also the contents

git-svn-id: https://160.78.46.112/svn/fsda.code.000/FSDA/trunk@2156 336e6153-a435-9040-aa94-c6aba0fb517b
  • Loading branch information
marco committed Nov 4, 2019
1 parent a7bde4e commit 0510626
Show file tree
Hide file tree
Showing 682 changed files with 4,785 additions and 8,539 deletions.
416 changes: 206 additions & 210 deletions Contents.m

Large diffs are not rendered by default.

76 changes: 76 additions & 0 deletions checkFSDAsetup.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
% This file
% 1) makes sure that the HTML files which are in subfolder
% (FSDA path)/helpfiles/FSDA
% are copied inside
% (docroot)/help/FSDA
% Note that to properly copy these file under windows, it is necessary to have
% administrator privileges (or to run MATLAB with administrator privileges)
%
% 2) creates searchable database, that is runs MATLAB function
% buildocsearchdb in path
% (FSDA path)/helpfiles/pointersHTML
%

%% Beginning of code
% Store current folder so that after the execution we go back to this
% folder
CurrentFolder=pwd;

% First navigate to FSDA main folder
FileName='addFSDA2path';
FullPath=which(FileName);
if isempty(FullPath)
error('FSDA:setup:WrongLocation','In order to properly run this file please navigate to the main folder of FSDA')
else
%Navigate to the main folder of FSDA
FSDAroot=fileparts(FullPath);
cd(FSDAroot)
end

%% Copy all FSDA .html files inside docroot/FSDA
fsep=filesep;

try
source=['helpfiles' filesep 'FSDA'];
destination=[docroot filesep 'FSDA'];
disp('Copying all FSDA documentation files which are in folder')
disp([FSDAroot filesep source])
disp('into')
disp(destination)
disp('------------------------')

[status,msg]=copyfile(source,destination,'f');
if status ==1
disp('HTML FSDA documentation files correctly copied')
else
disp('Due to write permission problems HTML files in:')
disp([pwd filesep source])
disp('could not be copied inside folder')
disp(destination)
disp('To solve the problem, please run MATLAB as administrator')
disp('or manually copy the files, otherwise the HTML FSDA help files will not be visible')
warning('FSDA:startup:NotCopied','Impossible to copy FSDA HTML documentation files')
end
catch
disp('Unknown error when trying to copy the HTML FSDA documentation files from')
disp([pwd filesep source])
disp('to:')
disp(destination)
end

subPointersFolder=[filesep 'helpfiles' filesep 'pointersHTML'];
folderwithSearchableDatabase=[FSDAroot subPointersFolder];


% Launch buildocsearchdb
% run builddocsearchdb in subfolder pointersHTML
try
builddocsearchdb(folderwithSearchableDatabase)
disp('FSDA searchable database correctly added')
catch
disp('Unknown error when trying to run MATLAB routine builddocsearchdb')
disp(['in folder: ' folderwithSearchableDatabase])
end

cd(CurrentFolder)
clearvars
36 changes: 18 additions & 18 deletions clustering/Contents.m
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,29 @@
%
% Name - Description - Category - Date last modified
%------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
% ClusterRelabel - Enables to control the labels of the clusters which contain predefined units - UTISTAT - 2019 May 20
% dempk - Performs a merging of components found by tkmeans - CLUS-RobClaMULT- 2019 May 20
% FSMmmdrs - Performs random start monitoring of minimum Mahalanobis distance - CLUS-RobClaMULT- 2019 May 20
% FSRmdrrs - Performs random start monitoring of minimum deletion residual - CLUS-RobClaREG - 2019 May 20
% ClusterRelabel - Enables to control the labels of the clusters which contain predefined units - UTISTAT - 2019 Oct 17
% dempk - Performs a merging of components found by tkmeans - CLUS-RobClaMULT- 2019 Oct 17
% FSMmmdrs - Performs random start monitoring of minimum Mahalanobis distance - CLUS-RobClaMULT- 2019 Oct 17
% FSRmdrrs - Performs random start monitoring of minimum deletion residual - CLUS-RobClaREG - 2019 Oct 17
% genSigmaGPCM - Generates covariance matrix for the 14 Gaussian Parsimonious Clustering Models - CLUS-RobClaMULT- 2019 May 20
% GowerIndex - Computes matrix of similarity indexes using Gower metric - CLUS-RobClaMULT- 2019 May 20
% lga - Performs linear grouping analysis - CLUS-RobClaREG - 2019 May 20
% MixSim - Generates k clusters in v dimensions with given overlap - CLUS-MixSim - 2019 Oct 03
% MixSimreg - Generates k regression hyperplanes in p dimensions with given overlap - CLUS-MixSim - 2019 May 20
% overlap - Computes the exact overlap given the parameters of the mixture - CLUS-MixSim - 2019 May 20
% overlapmap - Produce an interactive overlap map - CLUS-RobClaMULT- 2019 May 20
% lga - Performs linear grouping analysis - CLUS-RobClaREG - 2019 Oct 17
% MixSim - Generates k clusters in v dimensions with given overlap - CLUS-MixSim - 2019 Oct 17
% MixSimreg - Generates k regression hyperplanes in p dimensions with given overlap - CLUS-MixSim - 2019 Oct 17
% overlap - Computes the exact overlap given the parameters of the mixture - CLUS-MixSim - 2019 Oct 17
% overlapmap - Produce an interactive overlap map - CLUS-RobClaMULT- 2019 Oct 17
% restrdeter - Computes determinant restriction - CLUS-RobClaMULT- 2019 May 20
% restrdeterGPCM - Applies determinat restrictions for the 14 GPCM - CLUS-RobClaMULT- 2019 Oct 09
% restreigen - Computes eigenvalues restriction (without Dykstra algorithm) - CLUS-RobClaMULT- 2019 May 20
% restreigen - Computes eigenvalues restriction (without Dykstra algorithm) - CLUS-RobClaMULT- 2019 Oct 17
% restreigeneasy - Restreigen computes eigenvalues restriction (without Dykstra algorithm) - CLUS-RobClaMULT- 2019 May 20
% restrshapeGPCM - Produces the restricted shape matrix for the 14 GPCM - CLUS-RobClaMULT- 2019 Oct 09
% rlga - Performs robust linear grouping analysis - CLUS-RobClaREG - 2019 May 20
% simdataset - Simulates and-or contaminates a dataset given the parameters of a finite mixture model with Gaussian components - CLUS-MixSim - 2019 May 20
% simdatasetreg - Simulates a regression dataset given the parameters of a mixture regression model - CLUS-MixSim - 2019 May 20
% tclust - Computes trimmed clustering with scatter restrictions - CLUS-RobClaMULT- 2019 Oct 08
% rlga - Performs robust linear grouping analysis - CLUS-RobClaREG - 2019 Oct 17
% simdataset - Simulates and-or contaminates a dataset given the parameters of a finite mixture model with Gaussian components - CLUS-MixSim - 2019 Oct 17
% simdatasetreg - Simulates a regression dataset given the parameters of a mixture regression model - CLUS-MixSim - 2019 Oct 17
% tclust - Computes trimmed clustering with scatter restrictions - CLUS-RobClaMULT- 2019 Oct 17
% tclusteda - Computes tclust for a series of values of the trimming factor - CLUS-RobClaMULT- 2019 May 20
% tclustIC - Computes tclust for different number of groups k and restriction factors c - CLUS-RobClaMULT- 2019 May 20
% tclustICsol - Extracts a set of best relevant solutions - CLUS-RobClaMULT- 2019 May 20
% tclustreg - Performs robust linear grouping analysis - CLUS-RobClaREG - 2019 May 20
% tclustIC - Computes tclust for different number of groups k and restriction factors c - CLUS-RobClaMULT- 2019 Oct 17
% tclustICsol - Extracts a set of best relevant solutions - CLUS-RobClaMULT- 2019 Oct 17
% tclustreg - Performs robust linear grouping analysis - CLUS-RobClaREG - 2019 Oct 17
% tclustregIC - Computes tclustreg for different number of groups k and restriction factors c - CLUS-RobClaMULT- 2019 May 20
% tkmeans - Computes trimmed k-means - CLUS-RobClaMULT- 2019 May 20
% tkmeans - Computes trimmed k-means - CLUS-RobClaMULT- 2019 Oct 17
14 changes: 7 additions & 7 deletions combinatorial/Contents.m
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
%
% Name - Description - Category- Date last modified
%------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
% bc - Returns the Binomial coefficient - UTICOMB- 2019 May 20
% combsFS - Is an iterative algorithm equivalent to the MATLAB combs.m - UTICOMB- 2019 May 20
% lexunrank - Gives the the $k$-combination of $n$ elements of position $N$ in the lexicographic order of all combinations - UTICOMB- 2019 May 20
% nchoosekFS - Returns the Binomial coefficient or matrix containing all combinations - UTICOMB- 2019 May 20
% randsampleFS - Generates a random sample of k elements from the integers 1 to n (k<=n) - UTICOMB- 2019 May 20
% shuffling - Does a random permutation of the elements of input vector - UTICOMB- 2019 May 20
% subsets - Creates a matrix of indexes where rows are distinct p-subsets extracted from a set of n elements - UTICOMB- 2019 May 20
% bc - Returns the Binomial coefficient - UTICOMB- 2019 Oct 17
% combsFS - Is an iterative algorithm equivalent to the MATLAB combs.m - UTICOMB- 2019 Oct 17
% lexunrank - Gives the the $k$-combination of $n$ elements of position $N$ in the lexicographic order of all combinations - UTICOMB- 2019 Oct 17
% nchoosekFS - Returns the Binomial coefficient or matrix containing all combinations - UTICOMB- 2019 Oct 17
% randsampleFS - Generates a random sample of k elements from the integers 1 to n (k<=n) - UTICOMB- 2019 Oct 17
% shuffling - Does a random permutation of the elements of input vector - UTICOMB- 2019 Oct 17
% subsets - Creates a matrix of indexes where rows are distinct p-subsets extracted from a set of n elements - UTICOMB- 2019 Oct 17
79 changes: 79 additions & 0 deletions downloadGraphicalOutput.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@

%% Preamble
% The purpose of this file is to download and extract the graphical output
% of the html examples of FSDA contained in file
% http://rosa.unipr.it/FSDA/outputHTMLfiles.zip into
% (MATLAB docroot)/FSDA//images
% if this path exists
% or to
% (FSDA root)/helpfiles/FSDA/images.
% if the previous path does not exist.
%
% REMARK: this file is necessary just from those who have downloaded FSDA
% from Mathworks file exchange due to the limitation of 20MB size of the
% files inside fileexchange. Those who have downloaded FSDA from github do
% not need to run this file.

%% Beginning of code
% url from which to download file (including file name)
url = 'http://rosa.unipr.it/FSDA/outputHTMLfiles.zip';

% Set the timeout value to Inf so that the connection does not time out.
options = weboptions('Timeout',Inf);

% Define output folder
fsep=filesep;
outputfolder=[docroot filesep 'FSDA' filesep 'images'];

if exist(outputfolder,'dir')==7
% check that output folder. If output folder already exists this means
% that user has already copied there all the html documentation files
% and simply needs to extract the graphical output

try
% unzip file into outputfolder
unzip(url,outputfolder)
disp('Files correctly extracted')
disp('Now graphical output of the FSDA files is also visible locally')
catch
disp('Due to write permission problems zip file in:')
disp(url)
disp('could not be extracted inside folder')
disp(outputfolder)
disp('To solve the problem, please run MATLAB as administrator')
disp('or manually upzip the files, otherwise the HTML FSDA graphical output will not be visible locally')
warning('FSDA:dowloadGraphicalOutput:NotExtracted','Impossible to extract FSDA graphical output')

end
else
% in this case the HTML documentation files have not been copied yet
% and therefore the graphical output will be extracted into

FileName='addFSDA2path';
FullPath=which(FileName);
if isempty(FullPath)
error('FSDA:setup:WrongLocation','In order to properly run this file please navigate to the main folder of FSDA')
else
%Navigate to the main folder of FSDA
FSDAroot=fileparts(FullPath);
% cd(FSDAroot)
end
outputfolder=[FSDAroot filesep 'FSDA' filesep 'images'];

try
% unzip file into outputfolder
unzip(url,outputfolder)
disp(['Files correctly extracted into ' outputfolder])
disp('Now it is necessary to copy manually folder')
disp([FSDAroot filesep 'FSDA'])
disp([docroot fileseip help 'FSDA'])
disp('Alternatively, run routine checkFSDAsetup.m')
disp('which is located in the main folder of FSDA')
catch
disp('Unknown error when trying to unzip file into folder')
disp(outputfolder)
end

end


6 changes: 3 additions & 3 deletions examples/Contents.m
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
%
% Name - Description - Category- Date last modified
%------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
% brushFAN - Displays a GUI which enables brushing in the fanplot - GUI- 2019 May 20
% brushRES - Displays a GUI which enables brushing in resfwdplot - GUI- 2019 May 20
% brushROB - Displays a GUI which enables brushing in resindexplot - GUI- 2019 May 20
% brushFAN - Displays a GUI which enables brushing in the fanplot - GUI- 2019 Oct 17
% brushRES - Displays a GUI which enables brushing in resfwdplot - GUI- 2019 Oct 17
% brushROB - Displays a GUI which enables brushing in resindexplot - GUI- 2019 Oct 17
Loading

0 comments on commit 0510626

Please sign in to comment.