us.simulate: Ultrasound profile simulation

View source: R/MPMutils.R

us.simulateR Documentation

Ultrasound profile simulation

Description

Ultrasound profile simulation based on a reference dataset.

Usage

us.simulate(
  reps = 1,
  x = mpm.us,
  y = NULL,
  signature = NULL,
  features = 2:15,
  header = NULL,
  ...
)

Arguments

reps

Number of simulated vectors to be generated (default = 1).

x

Reference ultrasound features data.frame. By default, a dataset of 948 simulated profiles (object mpm.us) is used.

y

An optional numeric value defining the phenotype to be simulated: 0 for non-malignant and 1 for malignant (default = NULL).

signature

An optional string defining the metastatic risk signature to be simulated. One among: "LMR" (low metastatic risk), "MMR" (moderate metastatic risk), "HMR" (high metastatic risk), "MET" (metastatic signature). Defaults to NULL.

features

A vector of indices defining the ultasound features within the reference data.frame (default = 2:15).

header

A vector of new names for the ultrasound features vector. If NULL (default), feature names will be imported from the reference.

...

Currently ignored.

Value

A simulated ultrasound features vector.

Author(s)

Fernando Palluzzi fernando.palluzzi@gmail.com

See Also

See new.profile for ultrasound profile creation and us.predict for subject classification.

Examples


# Simulate a generic ultrasound profile
u <- us.simulate()
print(u)

# Simulate a non-malignant ultrasound profile
u0 <- us.simulate(y = 0)
print(u0)

# Simulate a malignant ultrasound profile
u1 <- us.simulate(y = 1)
print(u1)

# Simulate a high metastatic risk profile (single metastasis event)
u.hmr <- us.simulate(signature = "HMR")
print(u.hmr)

# Simulate a metastatic ultrasound profile (multiple metastasis events)
u.met <- us.simulate(signature = "MET")
print(u.met)


Morphonodepredictivemodel/morphonode documentation built on Feb. 15, 2023, 4:51 a.m.