EML icon indicating copy to clipboard operation
EML copied to clipboard

A number of examples in README.md no longer valid

Open wetlandscapes opened this issue 5 years ago • 4 comments

Hi, First, thank you very much for all the hard work you've put into this product. I'm just starting to use the EML package to document my own data. As such I've been looking over the README.md file and notice there are at least a few code examples that seem to no longer work. For example:

attributes <- read.table(system.file("extdata/hf205_attributes.csv", package = "EML")). Looking through the system files associated with the package I see that there is no "extdata" directory, but there is an "examples" directory. Similarly, there is no "hf205_attributes.csv" file.

I think either re-writing the README file, or adding these files back in, would help new users like myself better understand how this code works.

Thanks!

wetlandscapes avatar Apr 20 '19 20:04 wetlandscapes

@wetlandscapes Perhaps you are using the version from CRAN? The README shown here corresponds only to the current version on GitHub, you'll need to do remotes::install_github("ropensci/EML") and possibly restart your R session first.

(If you browse the system files on GitHub, you'll note there is indeed an extdata dir, eg: https://github.com/ropensci/EML/tree/master/inst/extdata). HTH!

cboettig avatar Apr 20 '19 20:04 cboettig

Ah, okay. That explains the large version difference on ropensci/github versus my package list. Maybe it is worth adding the installation line (remotes::install_github("ropensci/EML") to the README?

Thanks for your quick response. I greatly appreciate your efforts!

wetlandscapes avatar Apr 20 '19 20:04 wetlandscapes

good idea!

also we're really overdue for a new CRAN release so stay tuned for that.

cboettig avatar Apr 20 '19 21:04 cboettig

Added to 2.1.0 milestone, but if its already been fixed then just close the issue.

mbjones avatar Jul 02 '20 00:07 mbjones