search

Bioconductor / sweave2rmd

A project for converting Bioconductor Sweave documents to Rmd
Creative Commons Attribution Share Alike 4.0 International
8 stars 20 forks source link

Update checklist #70

Closed sonali8434 closed 1 year ago

sonali8434 commented 1 year ago

@jwokaty This is PR for the issue #69 , I tried to solve every issue mentioned if any further changes are needed please let me know. Thank you

sonali8434 commented 1 year ago

The build website action failed I think same issue is there in #50 for which you have already created an issue #52 .

jwokaty commented 1 year ago

The build website action failed I think same issue is there in #50 for which you have already created an issue #52 .

It's okay to disregard the build action.

sonali8434 commented 1 year ago

Thanks for this pull request to improve our documentation. I made a few suggestions to improve clarity.

Thank you @jwokaty for your review, I encountered some challenges while documenting examples of code blocks, which I have shared in Slack. I kindly request your assistance in resolving these issues whenever you have free time. Once these concerns are addressed, I will make the necessary final changes and commit them later. In the meantime, I am working on improving the documentation based on the feedback provided.

sonali8434 commented 1 year ago

@jwokaty I have implemented the requested changes and also grouped similar items on the checklist to improve clarity, If any further modifications are required please let me know.

I would also like to discuss a section, in the contribute document, there is a section on pandoc that includes a note which states:

"Note: We currently use this method to preprocess files since we can't directly convert from Sweave (.Rnw) to R Markdown (.Rmd). pandoc has some issues processing chunks of code, so we'll have to manually correct these sections of the .Rmd file."

However, there is no explanation or examples provided on how to manually convert a code chunk. Would you like me to address this issue and make the necessary changes to provide clearer instructions and examples?

sonali8434 commented 1 year ago

Close #69