Investigate possible use of styler

[jwokaty]

Investigate possible use of styler. Install and try on a conversion to see if it will reduce of some the manual formatting tasks to achieve sweave2rmd style, such as textwidth = 80, blank line between start / end of code blocks and surrounding content, etc.

• How do you use it?
• What features are helpful/interest?
• What features are missing?

[sonali8434]

To investigate the use of styler for automating some of the formatting tasks in the conversion from Sweave to R Markdown, you can follow these steps:

1. Install the styler package in your R environment using the following command: install.packages("styler")
2. Load the styler package into your R session: library(styler)
3. To use this package Open RStudio and go to the "Addins" section in the top menu bar.Select the "Style Active File" option from the available addins.Once you choose "Style Active File," the styler package will automatically analyze and make formatting changes to the code chunks in your active file.

• Advantages:

  • By using styler on an individual R file or a directory, you can automatically format the code to adhere to the specified style guide. This can help maintain a consistent and readable codebase.
  • Easy to use

• Disadvantages

  • In our sweave2rmd style standard we focus on textwidth=80, space between the paragraph etc which is not handled by the styler
  • According to Bioconductor style guide use 4 spaces instead of 2 in code chunk but if we use styler it will automatically adjust the indents to 2 spaces instead of 4 which is a problem.

Summary: styler is used to update the formatting of code chunk only but we in our project needs additional formatting like textwidth = 80, blank line between start / end of code blocks and surrounding content, etc. Which is not actually handled by styler.

[sonali8434]

@jwokaty close #76