Skip to contents

Create mapping metadata

Source: R/database-write-mapping.R
mapping_metadata.Rd

Generate the required metadata for a mapping table. This is mainly used to generate the necessary metadata when adding a new mapping table to the database with add_mapping_table().

Usage

mapping_metadata(
  from_code_type,
  to_code_type,
  map_version = "v0",
  ...,
  from_col = "from",
  to_col = "to",
  map_source = NA_character_,
  col_filters = NULL
)

Arguments

from_code_type

The type of coding system for the source codes (e.g., ICD-10, SNOMED-CT)

to_code_type

The type of coding system for the target codes (e.g., ICD-10, SNOMED-CT)

map_version

The version of the mapping metadata (default: "v0")

...

These dots are for future extensions and must be empty.

from_col

The column name for the source codes (default: "from")

to_col

The column name for the target codes (default: "to")

map_source

The source of the lookup metadata (default: NA_character_)

col_filters

Optional column filter specification. A named list where each element is a list with values (all valid values) and defaults (default filter values). NULL (default) means no column filters.

Value

A list containing the mapping metadata

See also

add_mapping_table()

Examples

mapping_metadata("ICD-10", "SNOMED-CT", map_version = "2023")
#> $mapping_table_name
#> [1] "ICD-10_SNOMED-CT_2023"
#> 
#> $from_code_type
#> [1] "ICD-10"
#> 
#> $to_code_type
#> [1] "SNOMED-CT"
#> 
#> $map_version
#> [1] "2023"
#> 
#> $from_col
#> [1] "from"
#> 
#> $to_col
#> [1] "to"
#> 
#> $map_source
#> [1] NA
#> 
#> $col_filters
#> [1] NA
#>