27.13 Function Definition Layout

20200105

Align function arguments in a function definition one per line. Aligning the = is also recommended to make it easier to view what is going on by presenting the assignments as a table.

Preferred

show_dial_plot <- function(label       = "UseR!", 
                           value       = 78, 
                           label_cex   = 3, 
                           label_color = "black")
{
  ...
}

Alternatives

show_dial_plot <- function(label="UseR!", 
                           value=78, 
                           label_cex=3, 
                           label_color="black")
{
  ...
}

show_dial_plot <- function(
                    label="UseR!", 
                    value=78, 
                    label_cex=3, 
                    label_color="black"
                  )

Discouraged

show_dial_plot <- function(label="UseR!", value=78,
                           label_cex=3,
                           label_color="black")
{
  ...
}

show_dial_plot <- function(label="UseR!", 
  value=78, 
  label_cex=3, 
  label_color="black")

---

Your donation will support ongoing availability and give you access to the PDF version of this book. Desktop Survival Guides include Data Science, GNU/Linux, and MLHub. Books available on Amazon include Data Mining with Rattle and Essentials of Data Science. Popular open source software includes rattle, wajig, and mlhub. Hosted by Togaware, a pioneer of free and open source software since 1984. Copyright © 1995-2022 Graham.Williams@togaware.com Creative Commons Attribution-ShareAlike 4.0