Returnera värden från funktioner

Introduktion till att skriva funktioner i R

Richie Cotton

Data Evangelist at DataCamp

En enkel summeringsfunktion

simple_sum <- function(x) {

  if(anyNA(x)) {

    return(NA)

  }

  total <- 0
  for(value in x) {
    total <- total + value
  }
  total
}

simple_sum(c(0, 1, 3, 6, NA, 7))

NA

Geometriskt medelvärde igen

calc_geometric_mean <- function(x, na.rm = FALSE) {
  assert_is_numeric(x)
  if(any(is_non_positive(x), na.rm = TRUE)) {
    stop("x contains non-positive values, so the geometric mean makes no sense.")
  }
  na.rm <- coerce_to(use_first(na.rm), "logical")
  x %>%
    log() %>%
    mean(na.rm = na.rm) %>%
    exp()
}

Returnera NaN med en varning

calc_geometric_mean <- function(x, na.rm = FALSE) {
  assert_is_numeric(x)
  if(any(is_non_positive(x), na.rm = TRUE)) {

    warning("x contains non-positive values, so the geometric mean makes no sense.")
    return(NaN)

  }
  na.rm <- coerce_to(use_first(na.rm), "logical")
  x %>%
    log() %>%
    mean(na.rm = na.rm) %>%
    exp()
}

Skäl att returnera tidigt

Du känner redan till svaret.
Indata är ett gränsfall.

Dölja returvärdet

simple_sum <- function(x) {
  if(anyNA(x)) {
    return(NA)
  }
  total <- 0
  for(value in x) {
    total <- total + value
  }
  total
}

simple_sum(c(0, 1, 3, 6, 2, 7))

Dölja returvärdet

simple_sum <- function(x) {
  if(anyNA(x)) {
    return(NA)
  }
  total <- 0
  for(value in x) {
    total <- total + value
  }

  invisible(total)

}

simple_sum(c(0, 1, 3, 6, 2, 7))

Många diagram returnerar värden osynligt

ggplot(snake_river_visits, aes(n_visits)) +
  geom_histogram(binwidth = 10)

Ett histogram över besök vid Snake River. Fördelningen är högersnedvriden och de flesta värden hamnar i den vänstra stapeln med under 5 besök per år. Det högsta värdet överstiger 300 besök per år.

Många diagram returnerar värden osynligt

srv_hist <- ggplot(snake_river_visits, aes(n_visits)) +
  geom_histogram(binwidth = 10)

str(srv_hist, max.level = 0)

List of 9
 - attr(*, "class")= chr [1:2] "gg" "ggplot"

Samma histogram över besök vid Snake River som visades på föregående slide.

Nu kör vi en övning!

Introduktion till att skriva funktioner i R