R/data-lahman.R

In snowflakedb/dplyr-snowflakedb: SnowflakeDB backend for dplyr

# Copyright 2017 Snowflake Computing Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

#' @import dplyr
NULL

#' Cache and retrieve an \code{src_snowflakedb} of the Lahman baseball database.
#'
#' This creates an interesting database using data from the Lahman baseball
#' data source, provided by Sean Lahman at
#' \url{http://www.seanlahman.com/baseball-archive/statistics/}, and
#' made easily available in R through the \pkg{Lahman} package by
#' Michael Friendly, Dennis Murphy and Martin Monkman. See the documentation
#' for that package for documentation of the inidividual tables.
#'
#' @name lahman
NULL

#' Lahman function for SnowflakeDB.
#' @export
#' @param ... Parameters to pass through for src_snowflakedb()
lahman_snowflakedb <- function(...) {
  copy_lahman(src_snowflakedb(...))
}