Function reference • readepi

Exported functions

readepi functions available to end-users

dhis2_get_attributes(): Get the target DHIS2 attribute identifiers and names

readepi(): Import data from different data_sources into R

show_example_file(): Display the structure of the credentials file

show_tables(): Display the list of tables in a database

visualise_table(): Visualize the first 5 rows of the data from a table

Internal functions

readepi functions for internal use

Shared helpers

read_credentials(): Read credentials from a configuration file

Fingertips

fingertips_get_args(): Get arguments for reading from Fingertips

fingertips_get_id_from_dm_id(): Get indicator ID from domain ID

fingertips_get_id_from_dm_name(): Get indicator ID from domain name

fingertips_get_id_from_name(): Get indicator ID from indicator name

fingertips_get_id_from_profile(): Get indicator ID from profile ID and/or profile name

fingertips_get_metadata(): get fingertips metadata

fingertips_get_profile_name(): Get profile name from Fingertips

fingertips_subset_columns(): Subset columns when reading from Fingertips

fingertips_subset_rows(): Subset records when reading from Fingertips

read_from_fingertips(): Read from Fingertips

REDCap

redcap_get_results(): Check and return data fetch from redcap

redcap_import_data(): Import data from REDCap under all scenario

redcap_read_data(): Read all rows and columns from redcap

redcap_read_fields(): Subset fields from a REDCap project

redcap_read_records(): Subset records from a REDCap project

redcap_read_rows_columns(): Subset records and columns from a REDCap project

read_from_redcap(): Import data from REDCap

DHIS2

dhis2_check_attributes(): Check the DHIS2 attributes for data import

dhis2_get_attributes(): Get the target DHIS2 attribute identifiers and names

dhis2_get_query_params(): Get the DHIS2 query parameters from the user

dhis2_get_relevant_attributes(): Get the relevant dataset

dhis2_login(): Check DHIS2 authentication details

dhis2_make_api_request(): Make an API request to the target DHIS2 system

dhis2_subset_fields(): Subset fields when reading from DHIS2

dhis2_subset_records(): Subset a specified set of records from a dataset imported from DHIS2

read_from_dhis2(): Import data form DHIS2

RDMS

sql_connect_to_server(): Establish connection to the server

sql_fetch_data_from_query(): Fetch data from server using an SQL query

sql_get_id_column_name(): get the id column name

sql_identify_table_and_query(): Identify queries or tables names from the user supplied string

sql_identify_table_name(): Detect table names from an SQL query

sql_select_data(): Subset data read from servers

sql_select_entire_dataset(): Fetch entire dataset in a table

sql_select_fields_only(): Select specified fields from a table

sql_select_records_and_fields(): Select specified records and fields from a table

sql_select_records_only(): Select specified records from a table

sql_server_read_data(): Read data from database management systems (DBMS).