epiverse-trace / readepi

An R package for importing epi data into R.
https://epiverse-trace.github.io/readepi/
Other
6 stars 5 forks source link

replace `data` with `dat` in documentation #16

Closed avallecam closed 1 year ago

avallecam commented 1 year ago

While creating a reprex, I got the default output from the data object (which is a base function) when the testing code I wrote returned an error and did not overlap the data object with new content to print. For example:

library(readepi)
data <- readepi(...)
#> Error in ...
data
#> function (..., list = character(), package = NULL, lib.loc = NULL,
#>  verbose = getOption("verbose"), envir = .GlobalEnv, overwrite = TRUE)
#> {
#> ...

Created on 2023-04-21 with reprex v2.0.2

From the style syntax chapter there is this recommendation at the end: "Where possible, avoid re-using names of common functions and variables. This will cause confusion for the readers of your code."

This mostly is the responsibility of the users, but the objects used could drive that issue.

I gather the alternative of dat from episoap code

Karim-Mane commented 1 year ago

This is accounted for