Skip to contents

Intestinal permeability value object

intestinal_permeability.Rd

Build an intestinal-permeability value object for create_compound()'s intestinal_permeability argument (or the writable Compound$intestinal_permeability field). Produces one default IntestinalPermeability alternative with parameter "Specific intestinal permeability (transcellular)".

Usage

intestinal_permeability(
  value,
  unit = "cm/min",
  name = "User defined",
  default = FALSE
)

Arguments

value

Numeric scalar. Intestinal-permeability value.

unit

Character. Unit for the parameter, validated against dimension "Velocity". Defaults to "cm/min".

name

Character. Name of the created alternative. Defaults to "User defined".

default

Logical. Whether this alternative is the group's default when it appears in a list of alternatives passed to the matching create_compound() argument or Compound field. Defaults to FALSE. Ignored for a single (non-list) value object, which is always the default. When a list has no element marked default = TRUE, the first element is the default (unchanged behaviour); marking two or more elements default = TRUE in the same list is an error.

Value

An intestinal_permeability_spec object to pass to create_compound().

See also

create_compound()

Other value-object helpers: age(), error(), fraction_unbound(), gestational_age(), height(), lipophilicity(), permeability(), solubility(), time(), values(), weight()

Examples

intestinal_permeability(1.14e-05)
#> $value
#> [1] 1.14e-05
#> 
#> $unit
#> [1] "cm/min"
#> 
#> $name
#> [1] "User defined"
#> 
#> $default
#> [1] FALSE
#> 
#> attr(,"class")
#> [1] "intestinal_permeability_spec" "osp_value_spec"              
create_compound(
  name = "Drug X",
  intestinal_permeability = intestinal_permeability(1.14e-05)
)
#> 
#> ── Compound: Drug X ────────────────────────────────────────────────────────────
#> 
#> ── Basic Properties ──
#> 
#> ── Physicochemical Properties ──
#> 
#> • Intestinal Permeability:
#>   • 1.14e-05 cm/min [Unknown]

# Several alternatives, the second marked as the default
create_compound(
  name = "Drug X",
  intestinal_permeability = list(
    intestinal_permeability(1.14e-05, name = "Caco-2"),
    intestinal_permeability(2e-05, name = "PAMPA", default = TRUE)
  )
)
#> 
#> ── Compound: Drug X ────────────────────────────────────────────────────────────
#> 
#> ── Basic Properties ──
#> 
#> ── Physicochemical Properties ──
#> 
#> • Intestinal Permeability:
#>   • Caco-2: 1.14e-05 cm/min [Unknown]
#>   • PAMPA (Default): 2e-05 cm/min [Unknown]