/ 
WebService-UMLSKS-Similarity-0.23
River stage zero No dependents
/ WebService::UMLSKS::Similarity

NAME

WebService::UMLSKS::Similarity - access the Unified Medical Language System (UMLS) via Webservices

VERSION

Version 0.23

SYNOPSIS

Basic Usage

 	use WebService::UMLS::Similarity;
    # Creating object of similarity with default constructor.
    my $similarity1 = WebService::UMLS::Similarity->new();
    
    # Creating object of Similarity by providing Configuration parameters.
    my @source_list = ("SNOMEDCT", "MSH");
    my @relation_list = ("PAR", "CHD","RB", "RN") ;
    my $similarity2 = WebService::UMLS::Similarity->new({"sources" =>  \@source_list,"rels"   =>  \@relation_list }	);
    
    # Creating object of Similarity by providing Cinfiguration file path and name.
    my $similarity3 = WebService::UMLS::Similarity->
    new({"config" => "/home/../config"}); 

	Format of configuaration file

	The configuaration fie accepted by the module should be in the fillowing format
	
	SAB :: include SNOMEDCT,MSH
	REL :: include PAR,RB
	DIR :: include U,H
	RELA :: include RB-has_part
	
	Here, SAB is the sources and REL is relations you want to include in 
	searching the UMLS. The list of sources and relations can be provided 
	seperated by comma. Some UMLS sources are :SNOMEDCT,MSH,UWDA,CSP,FMA,NCI

DESCRIPTION

This module creates a new instance of Similarity module and while creating the instance sets all the configuration parameters which are used in rest of the module. User can provide the configuration parameters by directly passing them to the constructor using a hash of parameters with 'sources' and 'rels' options or user can provide directly the configuration file path in the constructor using 'config' option. If the user does not specify any configuartion parameters, defualt parameters are used. 'SNOMEDCT' is the deafult source used and 'PAR|CHD' are the default relations used.

SUBROUTINES

new

This sub creates a new object of Display by taking in optional configuaration parameters.

initialiseParameters

This subroutine sets the configuaration parameters hash which are then used in rest of the module.

SEE ALSO

ValidateTerm.pm GetUserData.pm ConnectUMLS.pm ws-getUMLSInfo.pl ws-getAllowablePath.pl

AUTHORS

Mugdha Choudhari, University of Minnesota Duluth <chou0130 at d.umn.edu>

Ted Pedersen, University of Minnesota Duluth <tpederse at d.umn.edu>

COPYRIGHT

Copyright (C) 2011, Mugdha Choudhari, Ted Pedersen

This program 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 2 of the License, or (at your option) any later version.

This program 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 this program; if not, write to The Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.