Create a Genomic Event Record

Source: R/event_relevant_functions.R

Creates a record of a copy number change event Supports CNV and WGD events

create_event(
  haplotype,
  parent,
  child,
  region_name,
  CN_change,
  copy_index,
  event_type
)

Arguments

haplotype

Character string specifying the haplotype ("maternal" or "paternal")

parent

Character string identifying the parent cell

child

Character string identifying the child cell

region_name

Character string specifying the chromosome region (e.g., "chr1p", "chr2q")

CN_change

Numeric value indicating the copy number change

copy_index

Integer specifying which copy of the segment is affected

event_type

Character string describing the type of event

Value

A data frame containing a single row with the event information:

  • haplotype: Origin of the segment

  • parent: Parent cell identifier

  • child: Child cell identifier

  • region_name: Name of the affected region

  • CN_change: Copy number change value

  • copy_index: Index of the affected copy

  • event_type: Type of genomic event

Examples

event <- create_event(
  haplotype = "maternal",
  parent = "C1",
  child = "C2",
  region_name = "chr1p",
  CN_change = 1,
  copy_index = 1,
  event_type = "CNV"
)
#> Warning: restarting interrupted promise evaluation
#> Warning: internal error -3 in R_decompress1
#> Error: lazy-load database '/Library/Frameworks/R.framework/Versions/4.4-x86_64/Resources/library/cancerSimCraft/R/cancerSimCraft.rdb' is corrupt