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.

Sign up for GitHub

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

Jump to bottom

Update documentation #2

Open
xtracko opened this issue Mar 15, 2021 · 5 comments
Open

Update documentation #2

xtracko opened this issue Mar 15, 2021 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@xtracko
Copy link

xtracko commented Mar 15, 2021

Modify the Readme file: provide a high-level overview of simple and advanced methods, describe the structure input and output data.
@xtracko xtracko self-assigned this Mar 15, 2021
@martenson
Copy link
Member

  • Explicitly and clearly state this is a fork, link to upstream, and honor the license.

@martenson martenson transferred this issue from RECETOX/xMSannotator Jun 8, 2021
@hechth hechth self-assigned this Jun 11, 2021
@hechth hechth added the documentation Improvements or additions to documentation label Jun 11, 2021
@hechth hechth unassigned xtracko and hechth Sep 9, 2021
@hechth
Copy link
Member

hechth commented Sep 22, 2021

This package can be useful to add documentation skeletons to all functions in order to provide proper documentation for Roxygen:
https://github.com/vertesy/RoxygenReady

@hechth
Copy link
Member

hechth commented Oct 1, 2021

See also #51

@hechth
Copy link
Member

hechth commented Oct 30, 2021

To create an html page from package documentation, we can use the knitr package and the functions described here: https://www.rdocumentation.org/packages/knitr/versions/1.36/topics/knit_rd

@hechth
Copy link
Member

hechth commented Oct 30, 2021

The Rd2md package can be used to convert Rd files to markdown, see the attached example files
docs.zip

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@martenson @xtracko @hechth