Authentication | Setting Your Credentials: | Metadata | Metadata helpers in khisr | Metadata object filter | Working with metadata filters | Data analytics | Key Functions | Dimension (dx) | Filter (filter) | Constructing Queries | Data quality | Tracker data | System & utilities
Package: khisr 1.0.8.9000
khisr: An R Client to Retrieve Data from DHIS2
Provides a user-friendly interface for interacting with the District Health Information Software 2 ('DHIS2', <https://dhis2.org>) instance. It streamlines data retrieval, empowering researchers, analysts, and healthcare professionals to obtain and utilize data efficiently.
Authors:
khisr_1.0.8.9000.tar.gz
khisr_1.0.8.9000.zip(r-4.7-any)khisr_1.0.8.9000.zip(r-4.6-any)khisr_1.0.8.9000.zip(r-4.5-any)
khisr_1.0.8.9000.tgz(r-4.6-any)khisr_1.0.8.9000.tgz(r-4.5-any)
khisr_1.0.8.9000.tar.gz(r-4.7-any)khisr_1.0.8.9000.tar.gz(r-4.6-any)
khisr_1.0.8.9000.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
khisr/json (API)
| # Install 'khisr' in R: |
| install.packages('khisr', repos = c('https://damurka.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/damurka/khisr/issues
Pkgdown/docs site:https://khisr.damurka.com
Last updated from:e6e124e660. Checks:9 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel | OK | 143 | ||
| source / vignettes | OK | 197 | ||
| linux-release | OK | 206 | ||
| macos-release | OK | 151 | ||
| macos-oldrel | OK | 224 | ||
| windows-devel | OK | 104 | ||
| windows-release | OK | 86 | ||
| windows-oldrel | OK | 93 | ||
| wasm-release | OK | 119 |
Exports:%.^like%%.^Like%%.~^like%%.~^Like%%.~eq%%.~in%%.~like%%.~Like%%.~like$%%.~Like$%%.~token%%.d%%.eq%%.f%%.ge%%.gt%%.ieq%%.in%%.le%%.like%%.Like%%.like$%%.Like$%%.lt%%.ne%%.teq%%.tew%%.tge%%.tgt%%.tin%%.tle%%.tlike%%.tlt%%.tne%%.token%%.tsw%%>%analytics_dimensionget_analyticsget_analytics_by_levelget_analytics_outliersget_categoriesget_category_combosget_category_option_combosget_category_option_group_setsget_category_option_groupsget_category_optionsget_complete_data_set_registrationsget_data_element_group_setsget_data_element_groupsget_data_elementsget_data_elements_with_category_optionsget_data_setsget_data_sets_by_levelget_data_store_keysget_data_store_namespacesget_data_store_valueget_data_value_auditsget_data_value_setsget_dimensionsget_enrollment_analyticsget_enrollment_analytics_aggregateget_enrollmentsget_event_analyticsget_event_analytics_aggregateget_eventsget_file_resourcesget_geo_featuresget_indicator_group_setsget_indicator_groupsget_indicatorsget_metadataget_option_group_setsget_option_groupsget_option_setsget_optionsget_organisation_unit_groupsget_organisation_unit_groupsetsget_organisation_unit_levelsget_organisation_unitsget_organisations_by_levelget_period_typesget_program_stagesget_programsget_relationship_typesget_relationshipsget_sql_view_dataget_sql_viewsget_system_infoget_tracked_entitiesget_tracked_entity_attributesget_tracked_entity_typesget_user_groupsget_user_profileget_validation_resultskhis_api_versionkhis_base_urlkhis_credkhis_cred_clearkhis_display_namekhis_has_credkhis_usernamelocal_khis_quietmetadata_filtertracked_entity_filterwith_khis_quiet
Dependencies:askpassclicpp11curldplyrgenericsgluehmshttr2janitorjsonlitelifecyclelubridatemagrittropensslpillarpkgconfigpurrrR6rlangsnakecasestringistringrsystibbletidyrtidyselecttimechangeutf8vctrswithr
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Analytics Data Dimensions | %.d% %.f% analytics-dimension analytics_dimension |
| Retrieves Disaggregated Analytics Data from DHIS2 | get_analytics |
| Retrieves Analytics Table Data | get_analytics_by_level |
| Get Statistical Outliers from DHIS2 Analytics | get_analytics_outliers |
| Get Raw Data Set Completeness Registrations from a DHIS2 Instance | get_complete_data_set_registrations |
| Get Data Elements with Category Options | get_data_elements_with_category_options |
| Retrieves Data Set Reporting Rate Metrics | get_data_sets_by_level |
| Get the Keys in a DHIS2 Data Store Namespace | get_data_store_keys |
| Get DHIS2 Data Store Namespaces | get_data_store_namespaces |
| Get a Value from a DHIS2 Data Store | get_data_store_value |
| Get Data Value Change History from a DHIS2 Instance | get_data_value_audits |
| Get Raw Data Values from a DHIS2 Instance | get_data_value_sets |
| Retrieves Aggregated Enrollment Analytics Data from DHIS2 | get_enrollment_analytics |
| Get Aggregated (Pivot-Style) Enrollment Analytics from DHIS2 | get_enrollment_analytics_aggregate |
| Get Enrollments from a DHIS2 Instance | get_enrollments |
| Retrieves Aggregated Event Analytics Data from DHIS2 | get_event_analytics |
| Get Aggregated (Pivot-Style) Event Analytics from DHIS2 | get_event_analytics_aggregate |
| Get Events from a DHIS2 Instance | get_events |
| Get File Resources Metadata from a DHIS2 Instance | get_file_resources |
| Get Organisation Unit Geographic Features | get_geo_features |
| Get Metadata from a DHIS2 Instance | get_metadata |
| Get Organisations by Level | get_organisations_by_level |
| Get Relationships from a DHIS2 Instance | get_relationships |
| Get Data from a DHIS2 SQL View | get_sql_view_data |
| Get SQL Views Metadata from a DHIS2 Instance | get_sql_views |
| Get DHIS2 Instance System Information | get_system_info |
| Get Tracked Entities from a DHIS2 Instance | get_tracked_entities |
| Get Validation Rule Results from DHIS2 | get_validation_results |
| Retrieve the Configured DHIS2 API Version | khis_api_version |
| Retrieve the Configured DHIS2 API Base URL | khis_base_url |
| Sets DHIS2 Credentials | khis_cred |
| Clear the Credentials from Memory | khis_cred_clear |
| Retrieve the Configured Display Name | khis_display_name |
| Check if DHIS2 Credentials are Available | khis_has_cred |
| Retrieve the Configured Username | khis_username |
| khisr Configuration | khisr-configuration local_khis_quiet with_khis_quiet |
| Metadata Filter | %.eq% %.ge% %.gt% %.ieq% %.in% %.le% %.Like$% %.like$% %.Like% %.like% %.lt% %.ne% %.token% %.^Like% %.^like% %.~eq% %.~in% %.~Like$% %.~like$% %.~Like% %.~like% %.~token% %.~^Like% %.~^like% metadata-filter metadata_filter |
| DHIS2 Metadata Helper Functions | get_categories get_category_combos get_category_options get_category_option_combos get_category_option_groups get_category_option_group_sets get_data_elements get_data_element_groups get_data_element_group_sets get_data_sets get_dimensions get_indicators get_indicator_groups get_indicator_group_sets get_options get_option_groups get_option_group_sets get_option_sets get_organisation_units get_organisation_unit_groups get_organisation_unit_groupsets get_organisation_unit_levels get_period_types get_programs get_program_stages get_relationship_types get_tracked_entity_attributes get_tracked_entity_types get_user_groups get_user_profile metadata-helpers |
| Tracked Entity Attribute Filter | %.teq% %.tew% %.tge% %.tgt% %.tin% %.tle% %.tlike% %.tlt% %.tne% %.tsw% tracked_entity_filter |