30 new function label converter

[SanderDevisscher]

fixes #30

[soriadelva]

The code itself works well but I have a few comments that may be addressed:

• When labeltype is hardcoded, uppercase letters are not accepted, see:

  fistools/R/label_converter.R

  Lines 45 to 50 in f954789

  	#' df <- data.frame(
  	#' id = 1:1000,
  	#' labelnummer = sample(1:1000, 1000, replace = TRUE),
  	#' soort = sample(c("REE", "WILD ZWIJN", "DAMHERT"), 1000, replace = TRUE))
  	#'
  	#' labels <- label_converter(df, "id", "labelnummer", "soort", "REEKITS", 2020, "eloket")

  which throws an error, because only the lowercase reekits is accepted.

• The df of the final example cannot be constructed because column labeltype is not present in initial dataset labels, throwing an error on this line:

  fistools/R/label_converter.R

  Line 57 in f954789

  #' mutate(labeltype = ifelse(is.na(labeltype), sample(c("REEKITS", "REEGEIT", "REEBOK", NA), 1000, replace = TRUE), labeltype))

• Not that important, but I was wondering whether it would be better to place the function parameters in English (i.e., labelnumber instead of labelnummer, species_column instead of soort_column,...)

• Also not that important but it may be nice to add a line after each warning that involves checking, saying that the check passed. e.g., after this warning: 1: In label_converter(df, "id", "labelnummer", "REE", "labeltype", : soort_column: REE is not a column of input >> checking if it's an allowed species there could be a line saying check passed 🎉

[soriadelva]

When I try to load the function, it seems to get stuck after line 136, not sure what is happening but it may be good to check if this also happens for you @SanderDevisscher

[SanderDevisscher]

@soriadelva how do you mean gets stuck ?

[SanderDevisscher]

The code itself works well but I have a few comments that may be addressed:

• When labeltype is hardcoded, uppercase letters are not accepted, see:

  fistools/R/label_converter.R

  Lines 45 to 50 in f954789

  	#' df <- data.frame(
  	#' id = 1:1000,
  	#' labelnummer = sample(1:1000, 1000, replace = TRUE),
  	#' soort = sample(c("REE", "WILD ZWIJN", "DAMHERT"), 1000, replace = TRUE))
  	#'
  	#' labels <- label_converter(df, "id", "labelnummer", "soort", "REEKITS", 2020, "eloket")

  
  which throws an error, because only the lowercase reekits is accepted.

Fixed 🥳

• The df of the final example cannot be constructed because column labeltype is not present in initial dataset labels, throwing an error on this line:

  fistools/R/label_converter.R

  Line 57 in f954789

  #' mutate(labeltype = ifelse(is.na(labeltype), sample(c("REEKITS", "REEGEIT", "REEBOK", NA), 1000, replace = TRUE), labeltype))

Added a remark in the example. You should run an example which results in less than 1000 labels first (e.a. example 1)

• Not that important, but I was wondering whether it would be better to place the function parameters in English (i.e., labelnumber instead of labelnummer, species_column instead of soort_column,...)

Not implemented since function will be used by us only. I could translate everything to dutch if prefered (as a new issue)

• Also not that important but it may be nice to add a line after each warning that involves checking, saying that the check passed. e.g., after this warning: 1: In label_converter(df, "id", "labelnummer", "REE", "labeltype", : soort_column: REE is not a column of input >> checking if it's an allowed species there could be a line saying check passed 🎉

Implemented, whenever the function checks something and the check is succesfully completed check passed 🎉 is printed.

Additional fixes and enhancements:

1. I've implemented some logic to bypass the labeltype logic when labeltype_column is not provided and not needed (only needed with soort = "ree")
2. I've added a collapsed list of the allowed species and labeltypes to the error message you get when they are not allowed.

changes implemented

[soriadelva]

@soriadelva how do you mean gets stuck ?

it's weird, when I just run the function in the code itself it keeps on getting stuck at that same line, like this:

But if I select the whole code with ctrl + A and then run it, it seems to be fine 🤔