search

andrelmartins / bigWig

R interface to query UCSC bigWig files
14 stars 8 forks source link

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

Open wzhy2000 opened 5 years ago

wzhy2000 commented 5 years ago

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 commented 5 years ago

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 commented 5 years ago

Hello Andre,

I really hope you to publish your bigWig package. Danko lab often has new beginners to use your package. I only made a PDF manual for them using the R command "R CMD Rd2pdf bigWig". Today I only want to push this PDF manual to your repository, so I created an issue in your Github.

If you want to make a vignette for R users, I am very glad to collaborate with you. I knew some functions we used very often, maybe you need this information. Please let me know your thought.

Best regards,

Zhong Wang

On Wed, Sep 19, 2018 at 5:42 PM andrelmartins notifications@github.com wrote:

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é

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/andrelmartins/bigWig/issues/1#issuecomment-422968470, or mute the thread https://github.com/notifications/unsubscribe-auth/AIDT6rrO-3qRZqSx1OkNG5eQTLAU29lCks5ucrpFgaJpZM4Ww2Gb .

andrelmartins commented 5 years ago

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 commented 5 years ago

I think it would be great to have a vignette type document.

I don't think it would need to be all that long to be useful. Functions that I would suggest including:

Best, Charles

On Thu, Sep 20, 2018 at 2:29 PM andrelmartins notifications@github.com wrote:

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é

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/andrelmartins/bigWig/issues/1#issuecomment-423286648, or mute the thread https://github.com/notifications/unsubscribe-auth/ADFD_ZpfUSuCFht2eXq49Q-mHWEyrQV5ks5uc96JgaJpZM4Ww2Gb .

-- Assistant Professor Baker Institute for Animal Health College of Veterinary Medicine Cornell University 235 Hungerford Hill Road Ithaca, NY 14853

Phone: 315-395-4693 Website: http://www.dankolab.org E-mail: dankoc@gmail.com

guertinlab commented 4 years ago

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 commented 3 years ago

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 commented 3 years ago

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