-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
recommend adding example data files for documentation #50
Comments
Moreover, the quick start guide directs users to the source code to learn about more options for importing data.
I strongly discourage this. Novice users should not be expected to read the source code to learn how to use the package. This information should be distilled into a vignette for users to read. |
I see you added raw data to So this means your csv files currently in |
on a related note, this snippet in the README does not work for end users: Line 60 in 5b585c2
once you move the example files to their proper locations as described above, you will be able to do something like this instead: taco <- read_tidytacos(system.file("extdata", "tidytacos", "leaf", package = "tidytacos")) similarly, it would be nice (but not strictly required) if your dada and phyloseq examples worked: Lines 37 to 44 in 5b585c2
|
The quickstart explains how to load files into tidytacos:
but then proceeds to use the
urt
dataset for the rest of the tutorial, which is already a tidytacos object.It would be helpful to have an example file in your package in
inst/extdata
and use it in the tutorial, so users will have a better understanding of the expected file format.Additionally, it would be best practice to have code in
data-raw
to show howurt
andleaf
were created. https://r-pkgs.org/data.html#sec-data-data-rawThe text was updated successfully, but these errors were encountered: