Standardize Function Arguments

UBC-MDS / rimager

image manipulation and processing

https://ubc-mds.github.io/rimager/

Other

0 stars 1 forks source link

Standardize Function Arguments #57

Open Keanna-K opened 4 years ago

Keanna-K commented 4 years ago

As suggested from the review by @dkruszew and @fkhan72, we should ensure our function arguments satisfy the following:

[x] arguments are in the same order across all functions
[x] arguments have standardized names
- ex. all functions should use either output_path or output_file
[ ] standardize output from functions suggestions include:
- all functions should have a requirement for output_path
- change default output_path to the input_path with a function-specific string auto-concatenated to it like "_blurred" or "_circle"
  - have the outputs pop up in RStudio's Viewer

zoepan00 commented 4 years ago

For argument names, can we all do input_path and output_path?

zoepan00 commented 4 years ago

For arguments order, because output_path has default maybe we can do either

function(input_path, other_arguments, output_path=NULL)
function(other_arguments, input_path, output_path=NULL) which one do you guys prefer?

clsu22 commented 4 years ago

The first one is good. I'll add output_path argument in my function according to feedback.

Keanna-K commented 4 years ago

We also need to update the vignette and pkgdown site to match these the changes to our function documentation.

Keanna-K commented 4 years ago

For arguments order, because output_path has default maybe we can do either

function(input_path, other_arguments, output_path=NULL)

function(other_arguments, input_path, output_path=NULL) which one do you guys prefer?

I agree with @clsu22, the first option is good.