| Title: | Work with data that uses shorthand and symbols |
|---|---|
| Description: | Process character vectors of numerical data that contains non-numeric shorthand and symbols. |
| Authors: | Matt Kerlogue [aut, cre] |
| Maintainer: | Matt Kerlogue <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.1.0.9000 |
| Built: | 2024-08-20 04:45:29 UTC |
| Source: | https://github.com/mattkerlogue/shrthnd |
A shrthnd_tbl() has three sets of annotations that can be defined: a
title, a source_note and a set of general notes. This family of
functions allows you to view and modify these notes.
annotations(x) shrthnd_title(x) shrthnd_title(x) <- value set_title(x, value, .overwrite = FALSE) shrthnd_source_note(x) shrthnd_source_note(x) <- value set_source_note(x, value, .overwrite = FALSE) shrthnd_notes(x) shrthnd_notes(x) <- value set_notes(x, value, .overwrite = FALSE) add_notes(x, value, .add_before = Inf) add_notes(x) <- value set_tbl_antn( x, what = c("title", "source_note", "notes"), value, .overwrite = FALSE, .add = FALSE, .add_before = Inf )annotations(x) shrthnd_title(x) shrthnd_title(x) <- value set_title(x, value, .overwrite = FALSE) shrthnd_source_note(x) shrthnd_source_note(x) <- value set_source_note(x, value, .overwrite = FALSE) shrthnd_notes(x) shrthnd_notes(x) <- value set_notes(x, value, .overwrite = FALSE) add_notes(x, value, .add_before = Inf) add_notes(x) <- value set_tbl_antn( x, what = c("title", "source_note", "notes"), value, .overwrite = FALSE, .add = FALSE, .add_before = Inf )
x |
A |
value |
The value to set |
.overwrite |
Whether an existing value should be overwritten |
.add_before |
When adding notes, where to add the note (defaults to the end of the current set of notes) |
what |
Which note to set, one of |
.add |
When |
Use annotations() to see the all the annotations associated with a
shrthnd_tbl() object.
Use shrthnd_title(), shrthnd_source_note() and shrthnd_notes() get the
relevant annotations(s) of a shrthnd_tbl() object. Passing a value to these
functions (e.g. shrthnd_title(x) <- "My title") will set the value of these
annotation, overwriting the existing value(s).
set_title(), set_source_note(), and set_notes() also allow you to set
the value of these annotations. By default they will not permit overwriting
of existing values, setting .overwrite = TRUE permits this.
add_notes() allows you to append notes to the existing set of general
notes.
set_tbl_antn() is a low level helper function that powers the assignment
operations.
For shrthnd_title(), shrthnd_source_note() and shrthnd_notes()
a character vector of the note(s). For the setting functions returns
invisibly either x if the attribute was set or NULL if not.
note_to_title(),
shrthnd_tbl(),
zap_shrthnd()
x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]")) tbl <- tibble::tibble(x = x, sh_x = sh_x) sh_tbl <- shrthnd_tbl(tbl) |> set_title("My Example Table") |> set_source_note("Shrthnd documentation (2023)") |> set_notes(c("Note 1", "Note 2")) sh_tbl annotations(sh_tbl) shrthnd_title(sh_tbl) shrthnd_source_note(sh_tbl) shrthnd_notes(sh_tbl) add_notes(sh_tbl) <- "Note 3" shrthnd_notes(sh_tbl)x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]")) tbl <- tibble::tibble(x = x, sh_x = sh_x) sh_tbl <- shrthnd_tbl(tbl) |> set_title("My Example Table") |> set_source_note("Shrthnd documentation (2023)") |> set_notes(c("Note 1", "Note 2")) sh_tbl annotations(sh_tbl) shrthnd_title(sh_tbl) shrthnd_source_note(sh_tbl) shrthnd_notes(sh_tbl) add_notes(sh_tbl) <- "Note 3" shrthnd_notes(sh_tbl)
as_shrthnd() coerces a shrthnd_num() vector back to a character vector
re-inserting the shorthand tags.
as_shrthnd( x, digits = NULL, decimal_mark = NULL, big_mark = NULL, .pillar = FALSE, .trim = TRUE, .full_tag = FALSE )as_shrthnd( x, digits = NULL, decimal_mark = NULL, big_mark = NULL, .pillar = FALSE, .trim = TRUE, .full_tag = FALSE )
x |
A |
digits |
Number of digits to apply to |
decimal_mark |
The symbol used for decimal marks |
big_mark |
The symbol used to separate large numbers |
.pillar |
A flag for formatting within the |
.trim |
A flag to remove formatting white space |
.full_tag |
A flag to display full shrthnd tag information |
When calling as.character() on a shrthnd_num() the output is as you
would expect when calling it on a traditional numeric vector, as_shrthnd()
returns a character vector combining the numeric vector and the shorthand
tags.
When digits = NULL then shrthnd_double vectors are printed with the
number of digits set in the digits attribute of the vector, setting
digits in as_shrthnd() will override this value.
as_shrthnd() acts as the underlying formatter for the printing of
shrthnd_num() vectors to the console, including inside of data.frame()
and tibble::tibble() objects. When called directly as_shrthnd() trims
formatting whitespace, set .trim = FALSE to return a character vector
including formatting whitespace. For ease of display, tags are limited
to three characters and replaced with an ellipsis (...) if longer, set
.full_tag = FALSE to show the entire tag in the output vector.
A character vector
is_shrthnd_num(),
make_shrthnd_num(),
shrthnd_coercion,
shrthnd_maths,
shrthnd_num(),
shrthnd_tags(),
tag_match()
x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]"), digits = 1) as_shrthnd(sh_x) as_shrthnd(sh_x, digits = 3)x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]"), digits = 1) as_shrthnd(sh_x) as_shrthnd(sh_x, digits = 3)
find_annotations() takes a data frame and identifies possible annotations
contained within it and returns them as a named list. guess_annotations()
is a low-level helper that extracts annotations and returns them as a tibble
of cell values, row and column positions.
find_annotations( df, type = c("sheet", "cells"), title_first = TRUE, guess_source = TRUE, .row_var = row, .col_var = col, .value_var = value ) guess_annotations( df, type = c("sheet", "cells"), .row_var = row, .col_var = col, .value_var = value )find_annotations( df, type = c("sheet", "cells"), title_first = TRUE, guess_source = TRUE, .row_var = row, .col_var = col, .value_var = value ) guess_annotations( df, type = c("sheet", "cells"), .row_var = row, .col_var = col, .value_var = value )
df |
A data frame object |
type |
Whether the data frame is in "sheet" format or "cells" format |
title_first |
Whether the first annotation should be treated as the table title |
guess_source |
Whether to guess a source note from the annoations |
.row_var |
When using |
.col_var |
When using |
.value_var |
When using |
Data frames have a declared type, which must be either "sheet" format
(the default) or "cells" format. "sheet" format is a standard
two-dimensional data frame format, such as those read in by
base::read.csv() or readxl::read_excel(). "cells" format is for
data frames where each row represents a cell from a spreadsheet and contains
a variable for the cell's value, and separate variables providing the row
and column variable.
By default find_annotations() will try to help parse the annotations found
by guess_annotations(). With title_first = TRUE, the first annotation
found in a data frame is assumed to provide a title or label for the table
contained in the data frame. With guess_source = TRUE, the annotations
will be searched for one starting with either "Source:", "Data source:"
or "Source data:".
When using type = "cells" the variables identifying the row, column and
cell values are specified by .row_var, .col_var and .value_var
respectively.
example_df <- tibble::tibble( col1 = c( "Table 1", "An example sheet", "species", "Adelie", "Gentoo", "Chinstrap", "This table is based on data in the palmerpenguins R package", "Source: {palmerpenguins} R package" ), col2 = c(NA_character_, NA_character_, "bill_length_mm", "38.791", "47.505", "48.834", NA_character_, NA_character_), col3 = c(NA_character_, NA_character_, "bill_depth_mm", "18.346", "14.982", "18.421", NA_character_, NA_character_) ) example_df find_annotations(example_df) guess_annotations(example_df)example_df <- tibble::tibble( col1 = c( "Table 1", "An example sheet", "species", "Adelie", "Gentoo", "Chinstrap", "This table is based on data in the palmerpenguins R package", "Source: {palmerpenguins} R package" ), col2 = c(NA_character_, NA_character_, "bill_length_mm", "38.791", "47.505", "48.834", NA_character_, NA_character_), col3 = c(NA_character_, NA_character_, "bill_depth_mm", "18.346", "14.982", "18.421", NA_character_, NA_character_) ) example_df find_annotations(example_df) guess_annotations(example_df)
The is_shrthnd_* family of functions test whether a vector is either a
shrthnd_num(), or a shrthnd_list(). is_shrthnd_integer() and
is_shrthnd_double() test whether an object is a shrthnd_num() vector
and whether the underlying data type is an integer() or a double().
is_shrthnd_tbl() test whether an object is a shrthnd_tbl() tibble.
is_shrthnd_num(x) is_shrthnd_integer(x) is_shrthnd_double(x) is_numeric(x) is_shrthnd_list(x) is_shrthnd_tbl(x)is_shrthnd_num(x) is_shrthnd_integer(x) is_shrthnd_double(x) is_numeric(x) is_shrthnd_list(x) is_shrthnd_tbl(x)
x |
An object to be tested |
In keeping with base R practice around complex numeric objects such as
Date(), difftime() and POSIXct(), using is.numeric() on a
shrthnd_num() vector will return FALSE. The is_numeric() function
included in {shrthnd} will return TRUE if a vector is either a standard
numeric vector or is a shrthnd_num().
A logical vector
as_shrthnd(),
make_shrthnd_num(),
shrthnd_coercion,
shrthnd_maths,
shrthnd_num(),
shrthnd_tags(),
tag_match()
x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]")) is_shrthnd_num(sh_x) is_shrthnd_double(sh_x) y <- c("12", "34", "[c]", "NA", "56[e]", "78", "90[e]") sh_y <- shrthnd_num(y, c("[c]", "[e]")) is_shrthnd_num(sh_y) is_shrthnd_integer(sh_y) z <- 1:10 is.numeric(x) is.numeric(z) is_numeric(x) is_numeric(z) sh_l <- shrthnd_list(sh_x) is_shrthnd_list(sh_l) tbl <- tibble::tibble(x = x, sh_x = sh_x) sh_tbl <- shrthnd_tbl(tbl, title = "Example table") is_shrthnd_tbl(sh_tbl)x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]")) is_shrthnd_num(sh_x) is_shrthnd_double(sh_x) y <- c("12", "34", "[c]", "NA", "56[e]", "78", "90[e]") sh_y <- shrthnd_num(y, c("[c]", "[e]")) is_shrthnd_num(sh_y) is_shrthnd_integer(sh_y) z <- 1:10 is.numeric(x) is.numeric(z) is_numeric(x) is_numeric(z) sh_l <- shrthnd_list(sh_x) is_shrthnd_list(sh_l) tbl <- tibble::tibble(x = x, sh_x = sh_x) sh_tbl <- shrthnd_tbl(tbl, title = "Example table") is_shrthnd_tbl(sh_tbl)
make_shrthnd_num() allows you to construct a shrthnd_num vector from
a numeric vector of data values and a character vector of shorthand markers.
make_shrthnd_num(x = numeric(), tags = character(), digits = 2L)make_shrthnd_num(x = numeric(), tags = character(), digits = 2L)
x |
A numeric vector |
tags |
A character vector |
digits |
The number of digits to format the numeric vector with |
A shrthnd_num vector
as_shrthnd(),
is_shrthnd_num(),
shrthnd_coercion,
shrthnd_maths,
shrthnd_num(),
shrthnd_tags(),
tag_match()
make_shrthnd_num(c(1:3, NA, 4:5, NA), c("", "", "", "[c]", "", "[e]", NA))make_shrthnd_num(c(1:3, NA, 4:5, NA), c("", "", "", "[c]", "", "[e]", NA))
A shrthnd_tbl() has three sets of annotations, the
note_to_*() functions allow you to move a general note to either the
title or source note of a tibble. The *_to_notes()functions do the
opposite and (re)insert either the title and/or source note back into the
general notes.
note_to_title(x, note, .overwrite = FALSE) note_to_source_note(x, note, .overwrite = FALSE) title_to_notes(x, .add_before = 0) source_to_notes(x, .add_before = Inf) title_source_to_notes(x, .add_before = 0)note_to_title(x, note, .overwrite = FALSE) note_to_source_note(x, note, .overwrite = FALSE) title_to_notes(x, .add_before = 0) source_to_notes(x, .add_before = Inf) title_source_to_notes(x, .add_before = 0)
x |
A |
note |
The number of the note to move |
.overwrite |
Whether to overwrite existing |
.add_before |
Where to (re)insert the note |
For title_to_notes() and title_source_to_notes() the default is to
(re)insert the note at the start of the set of notes, for
source_to_notes() the default is to (re)insert the note at the end of
the set of notes.
A shrthnd_tbl()
annotations(),
shrthnd_tbl(),
zap_shrthnd()
x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]")) tbl <- tibble::tibble(x = x, sh_x = sh_x) sh_tbl <- shrthnd_tbl(tbl) |> set_notes(c("Note 1", "Note 2", "Note 3")) |> note_to_title(1) |> note_to_source_note(2) sh_tbl shrthnd_notes(sh_tbl) sh_tbl <- sh_tbl |> title_to_notes() shrthnd_notes(sh_tbl)x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]")) tbl <- tibble::tibble(x = x, sh_x = sh_x) sh_tbl <- shrthnd_tbl(tbl) |> set_notes(c("Note 1", "Note 2", "Note 3")) |> note_to_title(1) |> note_to_source_note(2) sh_tbl shrthnd_notes(sh_tbl) sh_tbl <- sh_tbl |> title_to_notes() shrthnd_notes(sh_tbl)
As an extension of the {vectrs} package, a shrthnd_num() is generally
coerced to behave as if it was a regular a numeric() vector. Where
{vectrs} doesn't automatically support coercion custom methods are
provided to enable a shrthnd_num() to be considered as a numeric vector.
The principles underpinning the coercion of a shrthnd_num() vector are
that to maximise compatability with base R and other packages, the vector
should generally behave as a numeric vector. This means that
as.numeric() will produce a bare numeric vector containing just the
numeric component of a shrthnd_num(). Similarly as.character() will
produce a character vector of the numeric component of a shrthnd_num().
To work with tags use shrthnd_tags() and the related
tag location functions. To produce a traditional
character vector combining the numeric component and tag component use
as_shrthnd() on a shrthnd_num() vector.
In keeping with base R practice around complex numeric objects such as
Date(), difftime() and POSIXct(), using is.numeric() on a
shrthnd_num() vector will return FALSE. Use is_shrthnd_num() to test
if a vector is a shrthnd_num() vector.
See shrthnd_maths for details on how shrthnd_num() works with
arithmetic, mathematical and (some) statistical operations.
Of particular note is that using is.na() on a shrthnd_num() vector is
designed to work on the numeric component, i.e. if numeric component is
missing but a tag marker is present then is.na() will return TRUE. Use
is_na_tag() to identify where there is no tag marker, or is_na_both() to
identify where both the numeric and tag components are missing.
as_shrthnd(),
is_shrthnd_num(),
make_shrthnd_num(),
shrthnd_maths,
shrthnd_num(),
shrthnd_tags(),
tag_match()
x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]")) as.numeric(sh_x) as.character(sh_x) is.na(sh_x)x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]")) as.numeric(sh_x) as.character(sh_x) is.na(sh_x)
shrthnd_list() generates a lookup table of shorthand markers in a vector,
either a character vector containing shorthand or a shrthnd_num() vector.
shrthnd_list( x, shorthand = NULL, na_values = c("", "NA"), dec = ".", bigmark = "," )shrthnd_list( x, shorthand = NULL, na_values = c("", "NA"), dec = ".", bigmark = "," )
x |
A character vector containing shorthand, or a |
shorthand |
A character vector of shorthand values to validate tags against |
na_values |
A character value of NA values to ignore |
dec |
The decimal separator for numbers |
bigmark |
The separator to the left of the decimal separator |
A list of shorthand positions in a vector
is_shrthnd_list() shrthnd_num()
x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") shrthnd_list(x) sh_x <- shrthnd_num(x) sh_x shrthnd_list(sh_x)x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") shrthnd_list(x) sh_x <- shrthnd_num(x) sh_x shrthnd_list(sh_x)
Arithmetic and most mathematical operations are supported on the numeric
component of shrthnd_num() vectors via the {vctrs} package without
having to wrap the vector in as.numeric().
You can use all the standard arithmetic infix operators (+, -, /, *,
^, %%, %/%, !). See vctrs::vec_arith() for further details.
Through vctrs::vec_math() the following generic mathematical operations
are supported:
from the Summary group generic:
prod(), sum(), any(), all().
from the Math group generic:
abs(), sign(), sqrt(), ceiling(), floor(), trunc(), cummax(),
cummin(), cumprod(), cumsum(), log(), log10(), log2(),
log1p(), acos(), acosh(), asin(), asinh(), atan(), atanh(),
exp(), expm1(), cos(), cosh(), cospi(), sin(), sinh(),
sinpi(), tan(), tanh(), tanpi(), gamma(), lgamma(),
digamma(), trigamma().
vctrs::vec_math() also enables support for mean(), is.nan(),
is.finite() and is.infinite().
In addition to these, the {shrthnd} package also provides methods for
range(), min(), max(), median() and quantile(). A
shrthnd_num() will work with sd() due to the ability of a
shrthnd_num() to be easily coerced to a numeric vector.
For other operations you will need to wrap the shrthnd_num vector in
as.numeric().
For all operations remember that you will likely need to set na.rm = TRUE
or whatever other method a function has for ignoring missing values.
as_shrthnd(),
is_shrthnd_num(),
make_shrthnd_num(),
shrthnd_coercion,
shrthnd_num(),
shrthnd_tags(),
tag_match()
x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]")) sh_x * 2 2 + sh_x mean(sh_x, na.rm = TRUE)x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]")) sh_x * 2 2 + sh_x mean(sh_x, na.rm = TRUE)
shrthnd_num() coerces a character vector containing numeric data values
with non-numeric tags into a numeric-like vector while also retaining the
tags.
shrthnd_num( x, shorthand = NULL, na_values = c("", "NA"), digits = 2L, paren_nums = c("negative", "strip"), dec = ".", bigmark = ",", convert_percent = TRUE )shrthnd_num( x, shorthand = NULL, na_values = c("", "NA"), digits = 2L, paren_nums = c("negative", "strip"), dec = ".", bigmark = ",", convert_percent = TRUE )
x |
A character vector of numeric values with shorthand |
shorthand |
A character vector of shorthand values |
na_values |
A character vector of NA values |
digits |
The number of digits for formatting numbers |
paren_nums |
How to handle numbers in parenthesis (e.g. |
dec |
The decimal separator for numbers |
bigmark |
The separator to the left of the decimal separator |
convert_percent |
Whether to convert percentages into decimals |
Data stored in documents and publications are regularly annotated with shorthand and symbols. Often these tags are found in the same container (e.g. a table or spreadsheet cell) as the value they are associated with, which requires further cleaning of the vector to extract the numeric values.
A simple approach is to discard the non-numeric components, however these
tags can convey information which you may wish to retain. shrthnd_num()
provides a data type that can store both the numeric data and the marker.
By default shrthnd_num() will extract any non-numeric values following
numeric ones and process them as a shorthand tag. However, you can
optionally supply a vector of tags, using the shorthand argument, if you
wish to validate the extracted tags and only accept vectors with specific
shorthand values.
If the underlying numeric values are real numbers (i.e. a double() vector)
the digits argument will be used to format the display of the
shrthnd_dbl vector (defaults to 2 decimal places).
A shrthnd_num vector
as_shrthnd(),
is_shrthnd_num(),
make_shrthnd_num(),
shrthnd_coercion,
shrthnd_maths,
shrthnd_tags(),
tag_match()
x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") shrthnd_num(x, c("[c]", "[e]"))x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") shrthnd_num(x, c("[c]", "[e]"))
shrthnd_tags() provides a character vector the same length as x with
the shorthand tags, or NA if that value has no tag. shrthnd_unique_tags()
is a convenience wrapper for unique(shrthnd_tags(x)), but can also be
called on a shrthnd_list() object.
shrthnd_tags(x) shrthnd_unique_tags(x)shrthnd_tags(x) shrthnd_unique_tags(x)
x |
A |
A character vector
as_shrthnd(),
is_shrthnd_num(),
make_shrthnd_num(),
shrthnd_coercion,
shrthnd_maths,
shrthnd_num(),
tag_match()
x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]")) shrthnd_tags(sh_x) shrthnd_unique_tags(sh_x)x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]")) shrthnd_tags(sh_x) shrthnd_unique_tags(sh_x)
shrthnd_tbl() provides a way to attach annotations to a table.
Specifically, it supports three types of annotation: a title, a
source note and general notes. The title and source_note are each
character vectors of length 1, while notes can be a character vector of
any length.
shrthnd_tbl(tbl, title = NULL, notes = NULL, source_note = NULL)shrthnd_tbl(tbl, title = NULL, notes = NULL, source_note = NULL)
tbl |
A |
title |
A character vector for the title of |
notes |
A character vector of general notes relating to |
source_note |
A character vector for a source note relating to |
A tibble with shrthnd annotations
annotations(),
note_to_title(),
zap_shrthnd()
x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]")) tbl <- tibble::tibble(x = x, sh_x = sh_x) shrthnd_tbl( tbl, title = "Example table", notes = c("Note 1", "Note 2"), source_note = "Shrthnd documentation, 2023" )x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]")) tbl <- tibble::tibble(x = x, sh_x = sh_x) shrthnd_tbl( tbl, title = "Example table", notes = c("Note 1", "Note 2"), source_note = "Shrthnd documentation, 2023" )
Base R's matching and location functions will work directly with the
numeric component of a shrthnd_num() vector, these functions provide
the same functionality but applied to the tag component.
tag_match(x, tag) tag_in(x, tag) where_tag(x, tag) any_tag(x) is_na_tag(x) is_na_both(x) locate_tag(x, tag) locate_any_tag(x) locate_no_tag(x)tag_match(x, tag) tag_in(x, tag) where_tag(x, tag) any_tag(x) is_na_tag(x) is_na_both(x) locate_tag(x, tag) locate_any_tag(x) locate_no_tag(x)
x |
A |
tag |
A single tag to locate |
tag_match() and tag_in() are wrappers around vctrs::vec_match() and
vctrs::vec_in() and thus equivalent to match() and %in% as applied
to the tag components of a shrthnd_num(). tag_match() will return an
integer vector showing the first location of the tag provided, tag_in()
will return TRUE or FALSE depending on whether the tag is in the
vector's shorthand.
where_tag() is equivalent to computing tags == tag, any_tag() is
equivalent to !is.na(tags). Using is.na() on a shrthnd_num() will
assess if the numeric component is missing, is_na_tag() is equivalent to
is.na(tags), is_na_both() tests if both the numeric and tag components
of a shrthnd_num() are missing. They return a logical
vector the same length as x.
locate_tag(), locate_any_tag(), located_no_tag() are equivalent to
passing the return values of where_tag(), any_tag() and is_na_tag() to
which(). They return an integer vector the same length as x.
For tag_match(), locate_tag(), locate_any_tag() and
locate_no_tag() an integer vector. For tag_in(), where_tag(),
any_tag(), is_na_tag() and is_na_both() a logical vector.
as_shrthnd(),
is_shrthnd_num(),
make_shrthnd_num(),
shrthnd_coercion,
shrthnd_maths,
shrthnd_num(),
shrthnd_tags()
x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]")) shrthnd_tags(sh_x) tag_match(sh_x, "[e]") tag_in(sh_x, "[e]") where_tag(sh_x, "[e]") any_tag(sh_x) is_na_tag(sh_x) is_na_both(sh_x) locate_tag(sh_x, "[e]") locate_any_tag(sh_x) locate_no_tag(sh_x)x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]")) shrthnd_tags(sh_x) tag_match(sh_x, "[e]") tag_in(sh_x, "[e]") where_tag(sh_x, "[e]") any_tag(sh_x) is_na_tag(sh_x) is_na_both(sh_x) locate_tag(sh_x, "[e]") locate_any_tag(sh_x) locate_no_tag(sh_x)
where_shrthnd_cols() applies is_shrthnd_num() across columns of a
data.frame (or elements in a list). which_shrthnd_cols() identifies the
columns in a data.frame or (elements of a list) by name or index position.
any_shrthnd_cols() tests whether a data.frame (or list) has any columns
that are shrthnd_num() vectors.
where_shrthnd_cols(x) which_shrthnd_cols(x, .names = FALSE) any_shrthnd_cols(x)where_shrthnd_cols(x) which_shrthnd_cols(x, .names = FALSE) any_shrthnd_cols(x)
x |
A data.frame (or list) |
.names |
A logical vector indicating whether to return column names or an integer vector of column positions (the default) |
For where_shrthnd_cols() a logical vector of the same length as
the number columns in x. For which_shrthnd_cols() a character vector
of names or an integer vector of index positions (the default). For
any_shrthnd_cols() either TRUE if there are any shrthnd_num()
vectors in the object or FALSE if not.
x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]")) tbl <- tibble::tibble(x = x, sh_x = sh_x) where_shrthnd_cols(tbl) which_shrthnd_cols(tbl) which_shrthnd_cols(tbl, .names = TRUE) any_shrthnd_cols(tbl)x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]")) tbl <- tibble::tibble(x = x, sh_x = sh_x) where_shrthnd_cols(tbl) which_shrthnd_cols(tbl) which_shrthnd_cols(tbl, .names = TRUE) any_shrthnd_cols(tbl)
The zap_*() functions remove annotations from a shrthnd_tbl() object.
zap_title(), zap_source_note() and zap_notes() remove the title,
source note and general notes respectively. zap_tbl() removes all three
types of annotations and also strips the shrthnd_tbl class from the object.
zap_shrthnd() is a low-level helper function that power the attribute
removal.
zap_title(x) zap_source_note(x) zap_notes(x) zap_tbl(x) zap_shrthnd(x, what = c("title", "source_note", "notes"), zap_class = FALSE)zap_title(x) zap_source_note(x) zap_notes(x) zap_tbl(x) zap_shrthnd(x, what = c("title", "source_note", "notes"), zap_class = FALSE)
x |
A |
what |
One or more of |
zap_class |
Whether to remove the "shrthnd_tbl" class |
To remove shrthnd from a shrthnd_num() vector use
as.numeric(), as.character() or as_shrthnd() to coerce the vector to
another type.
Returns x with relevant attributes removed
annotations(),
note_to_title(),
shrthnd_tbl()
x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]")) tbl <- tibble::tibble(x = x, sh_x = sh_x) sh_tbl <- shrthnd_tbl( tbl, title = "Example table", notes = c("Note 1", "Note 2"), source_note = "Shrthnd documentation, 2023" ) sh_tbl zap_title(sh_tbl) zap_source_note(sh_tbl) zap_notes(sh_tbl) zap_tbl(sh_tbl)x <- c("12", "34.567", "[c]", "NA", "56.78[e]", "78.9", "90.123[e]") sh_x <- shrthnd_num(x, c("[c]", "[e]")) tbl <- tibble::tibble(x = x, sh_x = sh_x) sh_tbl <- shrthnd_tbl( tbl, title = "Example table", notes = c("Note 1", "Note 2"), source_note = "Shrthnd documentation, 2023" ) sh_tbl zap_title(sh_tbl) zap_source_note(sh_tbl) zap_notes(sh_tbl) zap_tbl(sh_tbl)