NAME
CohortExplorer::Application::REDCap::Datasource - Class to initialise datasource stored under REDCap SQL framework ( see http://project-redcap.org/)
SYNOPSIS
The class is inherited from CohortExplorer::Datasource and overrides the following methods:
authenticate( $opts )
This method authenticates the user by running the authentication query against the REDCap database. The successful authentication returns array ref containing project_id
and data_export_tool
. In order to use CohortExplorer the user must have the permission to export data in REDCap (i.e. data_export_tool != 0
).
default_parameters( $opts, $response )
This method adds project_id
and data_export_tool
to the datasource object as default parameters. Moreover, the method runs a SQL query to check if the datasource is standard or longitudinal. If the datasource is longitudinal then, static_tables
and event_id (min)
are added as default parameters.
entity_structure()
This method returns the hash ref defining the entity structure.
table_structure()
This method returns the hash ref defining the table structure. The hash ref includes table attributes, variable_count
and label
.
variable_structure()
This method returns the hash ref defining the variable structure. The hash ref includes the condition appertaining to the inclusion/exclusion of the variables tagged as identifiers. The variable attributes include unit
, type
, category
and label
.
datatype_map()
This method returns variable type to SQL type mapping.
SEE ALSO
CohortExplorer::Command::Describe
CohortExplorer::Command::History
CohortExplorer::Command::Query::Search
CohortExplorer::Command::Query::Compare
LICENSE AND COPYRIGHT
Copyright (c) 2013 Abhishek Dixit (adixit@cpan.org). All rights reserved.
This program is free software: you can redistribute it and/or modify it under the terms of either:
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, or
the "Artistic Licence".
AUTHOR
Abhishek Dixit