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

Would you like to generate a manual in PDF format? #1

Open
wzhy2000 opened this issue Sep 19, 2018 · 7 comments
Open

Would you like to generate a manual in PDF format? #1

wzhy2000 opened this issue Sep 19, 2018 · 7 comments

Comments

@wzhy2000
Copy link

This is Zhong Wang at Danko lab. Your package has many users in our lab. But if you generate a manual in PDF, it will be helpful for the beginner.

Thanks,

Zhong Wang

@andrelmartins
Copy link
Owner

I am open to doing some sort of introductory manual. Do you have a list of topics you would like to see covered or any material prepared? Are you willing to collaborate on editing?

Best,
André

@wzhy2000
Copy link
Author

wzhy2000 commented Sep 20, 2018 via email

@andrelmartins
Copy link
Owner

When you say "publish", do you mean a journal article or do you mean something like CRAN or bioconductor ? As for the PDF, I'm willing to add that as another release file.

Although what I had in mind was something closer to an actual manual. To that end, any information you have on what functions are most used in the lab and what are the common issues for new users, would be very valuable.

Best,
André

@dankoc
Copy link
Collaborator

dankoc commented Sep 23, 2018 via email

@guertinlab
Copy link
Contributor

I am working with @lutus, who has the beginnings of a vignette (https://github.com/lutus/bigWig/raw/master/doc/bigWig.pdf). Should we try to polish the vignette so that you can submit to bioconductor?

@mjg54
Copy link
Collaborator

mjg54 commented Aug 19, 2020

an HTML vignette is now built with R CMD build bigWig. I rendered a PDF as well, but I don't know where to include it in the package. Any suggestions?

@andrelmartins
Copy link
Owner

We could add it as an extra asset with new releases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants