r-hyperspec / hySpc.dplyr

Interface between hyperSpec and dplyr
https://r-hyperspec.github.io/hySpc.dplyr/
MIT License
5 stars 1 forks source link

Rename `setLabels` family functions to meet Tidyverse requirements #35

Open GegznaV opened 4 years ago

GegznaV commented 4 years ago

The family of setLabels functions should be renamed as it doesn't follow Tidyverse conventions, e.g., use only lower-case letters.

https://github.com/r-hyperspec/hySpc.dplyr/blob/ffbb179f30e3a3c47073f40847577f0dd77a27f0/R/setLabels.R#L19

I suggest renaming:

1) setLabelslabels_set() (I think, that labels_set() and labels_get() should live in the main hyperSpec package as they give core functionality to work with labels). 2) setLabels_transmutelabels_transmute() (Why is this function needed at all?) 3) setLabels_selectlabels_select 4) setLabels_renamelabels_rename


Yet, it is still a bit vague for me, what these functions do and why are they needed. The file with these functions lacks:

  1. description/better explanation, why they are needed;
  2. examples (at least one per function;
  3. unit tests (at least one per function).