Skip to content
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

Add a system.file() example that the user could use #39

Open
1 of 4 tasks
russHyde opened this issue Oct 30, 2019 · 1 comment
Open
1 of 4 tasks

Add a system.file() example that the user could use #39

russHyde opened this issue Oct 30, 2019 · 1 comment
Labels
documentation Changes to README / Vignettes / manpages and suggeested blogposts

Comments

@russHyde
Copy link
Owner

russHyde commented Oct 30, 2019

At present, the example code in the dupree README couldn't be reran by a user if they downloaded dupree from CRAN, say, since they would require the dupree source code for the examples to work (and dupree isn't particularly bad for duplication within the source code).

It would be useful to have a couple of dupree examples that use example files (from inst/) that CRAN users could access

  • - add two example files to inst.
  • - add example sections that use these system.files to the dupree() roxygen
  • - use the system.files within a vignette or in the README.
  • - also (but unrelated) show how to visualise a similarity network using tidygraph in the vignette
@russHyde russHyde mentioned this issue Nov 4, 2019
2 tasks
@russHyde
Copy link
Owner Author

russHyde commented Nov 6, 2019

Have added a single example file that is used in the dupree::dupree() examples.

Further extension of the docs would be valuable

@russHyde russHyde added the documentation Changes to README / Vignettes / manpages and suggeested blogposts label Mar 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes to README / Vignettes / manpages and suggeested blogposts
Projects
None yet
Development

No branches or pull requests

1 participant