R/elucidate.R

In bcgov/elucidate: Convenience Functions to Help Researchers Elucidate Patterns in Their Data

# Copyright 2021 Province of British Columbia
#
# 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.

#' "elucidate: a collection of convenience functions to help researchers elucidate patterns in their data."
#'
#' "This package provides a collection of convenience functions to facilitate
#' exploratory data analysis by researchers. While many of the functions are
#' geared towards data analysis tasks typical in the behavioural and health
#' sciences (e.g. analysis of numerical variables between experimental groups),
#' they are more widely applicable. The package has also been designed with the
#' goal of making common analytical processes in R more accessible to (data)
#' science trainees by providing a consistent API for data analysis and
#' visualization. Note This package is currently in development and its
#' functionality will be improved over time."
#'
#' @docType package
#' @name elucidate
"_PACKAGE"