v_proportion | R Documentation |
Constructors and methods for a proportion data type.
v_proportion
and prop
are synonyms that each create a
new v_proportion
object subclassed from v_continuous
and
vctrs_vctr
.
Support: \mathbf{[0, 1]}* (plus NA_real_
)
Prototype: double
* - i.e. floating-point number
v_proportion( x = ptypeFUN(), internal_name = "", context, auto_compute_summary = auto_compute_default, extra_descriptors = list() ) prop( x = ptypeFUN(), internal_name = "", context, auto_compute_summary = auto_compute_default, extra_descriptors = list() ) is_proportion(x) is_prop(x) as_proportion(x) ## S3 method for class 'v_proportion' as_canonical(x)
x |
nonnegative |
internal_name |
the internal name of the variable |
context |
a |
auto_compute_summary |
an indicator of whether the |
extra_descriptors |
A |
Other stype types:
tbl_analysis
,
v_binary
,
v_continuous_nonneg
,
v_continuous
,
v_count
,
v_nominal
,
v_ordered
,
v_rcensored
# Example data src_dbl <- c(1, 0.5, .01, 0, NA_real_) # Constructor for the `v_proportion` class. One can also use `prop` # which is a synonym for the `v_proportion` function. v <- v_proportion( x = src_dbl, internal_name = "v_example", context = context( short_label = "important_var", long_label = "Very important variable" ), extra_descriptors = list() ) # Helper functions and methods is_proportion(v) as_proportion(src_dbl) as.character(v) as_canonical(v)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.