README.md

In czeildi/datasetsexperiment: Experiment with the usage of internal and external data

datasetsexperiment

The goal of datasetsexperiment is to be a minimal R package to test usage of external and internal data in R packages.

Installation

You can install the dev version of datasetsexperiment from Github

devtools::install_github("czeildi/datasetsexperiment")

Usage

datasetsexperiment::print_internal_in_body()
#> [1] "piece of data saved as both internal and external"
datasetsexperiment::print_internal_from_argument()
#> [1] "piece of data saved as both internal and external"
datasetsexperiment::print_external_in_body()
#> Error in datasetsexperiment::print_external_in_body(): object 'external_only' not found
datasetsexperiment::print_external_from_argument()
#> Error in datasetsexperiment::print_external_from_argument(): object 'external_only' not found
datasetsexperiment::external_only
#> [1] "piece of external only data"

library("datasetsexperiment")

datasetsexperiment::print_internal_in_body()
#> [1] "piece of data saved as both internal and external"
datasetsexperiment::print_internal_from_argument()
#> [1] "piece of data saved as both internal and external"
datasetsexperiment::print_external_in_body()
#> [1] "piece of external only data"
datasetsexperiment::print_external_from_argument()
#> [1] "piece of external only data"
datasetsexperiment::external_only
#> [1] "piece of external only data"

Created on 2018-06-16 by the reprex package (v0.2.0).

Background

In a package you might have a dataset that you want to use in your functions and want to publicize as well as external dataset. In this case you should save this dataset as both internal and external data with

devtools::use_data(external_and_internal)
devtools::use_data(external_and_internal, internal = TRUE)

If you only save your data as external data:

You get a R CMD check note about undefined global variables: 'external_only'. This you can eliminate with

utils::globalVariables("external_only")

but then you only conceal the problem.

If your package is loaded, everything looks fine but if someone want's to use your function without loading your package:

datasetsexperiment::print_external_in_body()

it will fail with object 'external_only' not found. This error will be probably frustrating as your user can see the data just fine with

datasetsexperiment::external_only

.

czeildi/datasetsexperiment documentation built on May 21, 2019, 9:37 a.m.