Pipe operator

Description

See magrittr::%>% for details.

Usage

lhs %>% rhs

Arguments

Value

The result of calling rhs(lhs).

Academic year

Description

In this function, a date is translated to the academic year in which it falls. This is based on a start of the academic year on the 1st of September.

Usage

academic_year(x, start_1_oct = FALSE)

Arguments

Value

The academic year in which the specified date falls

See Also

Other vector calculations: clean_multiple_underscores(), interval_round(), month_name(), sum_0_1(), transform_01_to_ft()

Examples

academic_year(lubridate::today())

clean multiple underscores

Description

Replaces multiple underscores into a single underscore in a vector or string.

Usage

clean_multiple_underscores(x)

Arguments

Value

cleaned vector or string.

See Also

Other vector calculations: academic_year(), interval_round(), month_name(), sum_0_1(), transform_01_to_ft()

Examples

clean_multiple_underscores("hello___world")

Convert character vector to numeric, ignoring irrelevant characters.

Description

Convert character vector to numeric, ignoring irrelevant characters.

Usage

destring(x, keep = "0-9.-")

Arguments

Value

vector of type numeric

Examples

destring("24k")
destring("5,5")

Group Summary

Description

Calculate the means (or other function) per group to analyze how each segment behaves. It scales each variable mean into the 0 to 1 range to easily profile the groups according to its mean. It also calculates the mean regardless of the grouping. This function is also useful when you want to profile cluster results in terms of its means. It automatically adds a row representing the summary of the column regardless of the group_var categories, which is useful to compare each segment with the whole population. It will exclude all factor/character variables.

Usage

group_summary(data, group_var, group_func = mean)

Arguments

Value

Grouped data frame.

Group Summary Rank

Description

Similar to 'group_summary' function, this one computes the rank of each value in order to quickly know what is the value in each segment that has the highest value (rank=1). 1 represents the highest number. It will exclude all factor/character variables.

Usage

group_summary_rank(data, group_var, group_func = mean)

Arguments

Value

Grouped data frame, showing the rank instead of the absolute values.

Interval round

Description

Function to round numeric values in a vector to values from an interval sequence.

Usage

interval_round(x, interval)

Arguments

Value

The vector corrected for the given interval

See Also

Other vector calculations: academic_year(), clean_multiple_underscores(), month_name(), sum_0_1(), transform_01_to_ft()

Examples

interval_round(c(5, 4, 2, 6), interval = seq(1:4))

LTrim

Description

Trim leading whitespace from sting.

Usage

ltrim(x)

Arguments

Value

Cleaned string.

Examples

trim(" hello")

Median top 10 percentage

Description

Calculate the median of the top ten percentage of the values.

Usage

median_top_10(x, na.rm = FALSE)

Arguments

Value

A numerical value

Examples

median_top_10(mtcars$cyl)

Mode (most common value)

Description

Determine the most common value in a vector. If two values have the same frequency, the first occurring value is used.

Usage

mode(x, na.rm = FALSE)

Arguments

Value

the most common value in the vector x

Examples

mode(c(0, 3, 5, 7, 5, 3, 2))

Month Name

Description

Transform month from numeric to equivalent in specified language.

Usage

month_name(month_numeric, lang = "nl")

Arguments

Value

Character string representation of month in specified language.

See Also

Other vector calculations: academic_year(), clean_multiple_underscores(), interval_round(), sum_0_1(), transform_01_to_ft()

RTrim

Description

Trim trailing whitespaces from string.

Usage

rtrim(x)

Arguments

Value

Cleaned string.

Examples

trim("hello ")

Replace all occurences of a pattern in a file

Description

Replace all occurences of a pattern in a file

Usage

str_replace_all_in_file(
  file,
  pattern,
  replacement = "[...]",
  only_comments = TRUE,
  collapse = FALSE
)

Arguments

Value

NULL, the file is modified in place

Sum 0 1

Description

This function is the same as sum(), with one exception: If the outcome value is higher than 1, it will always return 1.

Usage

sum_0_1(x)

Arguments

Value

0 or 1. Depending on whether the sum is greater than 0 or not.

See Also

Other vector calculations: academic_year(), clean_multiple_underscores(), interval_round(), month_name(), transform_01_to_ft()

Test 01

Description

This function tests whether the vector is actually a boolean, but is encoded as a 0/1 variable. The function checks for numeric vectors whether the only occurring values are 0, 1, or NA. At character and factor vectors checks whether the only occurring values are "0", "1", or NA to be. If there is a 0/1 variable, TRUE is returned, in all others cases FALSE.

Usage

test_01(x)

Arguments

Value

A TRUE/FALSE value on the test

See Also

Other booleans: transform_01_to_ft()

Examples

vector <- c(0, 1, 0, 1, 1, 1, 0)
test_01(vector)

Test Yes/No Responses

Description

This function tests if a vector of responses are yes or no.

Usage

test_yes_no(responses)

Arguments

Value

A logical vector indicating if each response is yes or no.

Transform 01 to FT

Description

If the vector is a 0/1 vector, it is converted to a logical one TRUE/FALSE vector. This transformation is performed only if the vector contains only values 0, 1, or NA. If this is not the case returns the original variable. This transformation can be done on numeric, string, and factor vectors.

Usage

transform_01_to_ft(x)

Arguments

Value

The transformed vector if a transformation is possible. If no transformation is possible, the original vector returned.

See Also

Other vector calculations: academic_year(), clean_multiple_underscores(), interval_round(), month_name(), sum_0_1()

Other booleans: test_01()

Examples

vector <- c(0, 1, 0, 1, 1, 1, 0)
transform_01_to_ft(vector)

Transform Logical to Yes/No and Vice Versa

Description

This function transforms a logical vector to a vector of yes/no strings or vice versa.

Usage

transform_logical_yes_no(x, lang = "nl")

Arguments

Value

A vector of yes/no strings or a logical vector.

Translate Yes/No Responses

Description

This function translates yes/no responses from a given language to English.

Usage

translate_yes_no(responses, source_language = "nl")

Arguments

Value

A vector of translated responses.

Trim

Description

Trim both leading and trailing whitespaces from string.

Usage

trim(x)

Arguments

Value

Cleaned string.

Examples

trim(" hello ")