Function to translate park codes to park names #132

mdkompella · 2025-03-10T19:58:08Z

I added the function get_park_names() which takes a dataframe with a unit code column and adds a unit name column.

…olumn to dataframe. added warning message if unit code not found. added proper roxygen documentation.

RobLBaker

Could this be a single parameter, e.g. df$unit_column?

You could then eliminate the first line of code.

RobLBaker · 2025-03-10T20:19:17Z

R/get_park_names.R

+#'  get_park_names(exampleDF, "parkCode")
+#'  }
+
+get_park_names <- function(df, unit_column) {


Could this be a single parameter, e.g. "df$unit_column"? Then you could remove the first line of code in the function.

I kept them separate because I use the data frame provided by the user to return that same data frame with the new column appended. Would you rather the function return the dataframe or the list of park names?

RobLBaker · 2025-03-10T20:20:20Z

R/get_park_names.R

+  unit_codes_na <- NULL
+
+  #copied from Rob's function
+  for (i in 1:length(unit_code)) {


This can cause some problems with edge cases where the length is zero. It's typically better to use seq_along() (usually I use it in combination with length()).

RobLBaker · 2025-03-10T20:21:30Z

R/get_park_names.R

+    #else if ref_data corresponds to more than one park name, assign park_name to NA and add unit code to na list
+    #else assign park name to the full unit (park) name
+    if (length(ref_data) == 0) {
+      park_name <- NA_character_


I think this "NA_character_" variable is undefined. Should it be user-supplied in the function call?

RobLBaker · 2025-03-10T20:24:41Z

R/get_park_names.R

+      park_name <- NA_character_
+      unit_codes_na <- append(unit_codes_na, unit_code[i])
+    } else if (length(ref_data[[1]]) != 1) {
+      park_name <- NA_character_


Is there an advantage to using NA_character_ as opposed to just NA?

Since the column is all character class, I thought an NA_character_ would keep missing values consistent to the column type. Let me know if you think a regular NA would work better.

RobLBaker · 2025-03-10T20:30:49Z

R/get_park_names.R

+  # create new dataframe with unit name column
+  df2 <- df %>%
+    mutate(parkName = unit_names) %>%
+    relocate(parkName, .after = unit_column)


need to add the package designation for relocate (eg. dplyr::relocate(parkName... ).

relocate also appears to be calling select, which has been deprecated in tidyselect 1.1.0. Is there an updated version of relocate that could be used (or base R?):

Warning message: Using an external vector in selections was deprecated in tidyselect 1.1.0. ℹ Please use all_of()orany_of()` instead.

Was:

data %>% select(unit_column)

Now:

data %>% select(all_of(unit_column))

See
https://tidyselect.r-lib.org/reference/faq-external-vector.html.
This warning is displayed once every 8 hours.
Call lifecycle::last_lifecycle_warnings() to see where this
warning was generated.

<warning/lifecycle_warning_deprecated>
Warning:
Using an external vector in selections was deprecated in
tidyselect 1.1.0.
ℹ Please use all_of() or any_of() instead.

Was:

data %>% select(unit_column)

Now:

data %>% select(all_of(unit_column))

See
https://tidyselect.r-lib.org/reference/faq-external-vector.html.

Backtrace:
▆

├─global get_park_names(df, "park_units")

│ └─df %>% mutate(parkName = unit_names) %>% ...

├─dplyr::relocate(., parkName, .after = unit_column)

└─dplyr:::relocate.data.frame(., parkName, .after = unit_column)

└─dplyr:::eval_relocate(...)

└─tidyselect::eval_select(after, data, env = env, error_call = error_call)

└─tidyselect:::eval_select_impl(...)

├─tidyselect:::with_subscript_errors(...)

│ └─base::withCallingHandlers(...)

└─tidyselect:::vars_select_eval(...)

└─tidyselect:::walk_data_tree(expr, data_mask, context_mask)

└─tidyselect:::eval_sym(expr, data_mask, context_mask)

RobLBaker · 2025-03-10T20:31:28Z

R/get_park_names.R

+
+  # create new dataframe with unit name column
+  df2 <- df %>%
+    mutate(parkName = unit_names) %>%


need to add the package designation for "mutate" (e.g. dplyr::mutate)

RobLBaker · 2025-03-10T20:41:41Z

R/get_park_names.R

+    # if ref_data list is empty (no corresponding park name) assign park_name to NA and add unit code to na list
+    # else if ref_data corresponds to more than one park name, assign park_name to NA and add unit code to na list
+    # else assign park name to the full unit (park) name
+    if (length(ref_data) == 0) {


I don't think this is doing what you want it to do. For most(?) responces (e.g. ROMO), the length of ref_data is 13. I think perhaps you want nrow(ref_data), which would be 1 for ROMO.

This first statement checks if the unit code resolved to no park names at all, meaning ref_data is not populated. I could also use: if (is.null(nrow(ref_data)), since ref_data remains null if there is no corresponding park name.

RobLBaker · 2025-03-10T20:52:58Z

R/get_park_names.R

Overall, this looks good. I think you need to take care of the functions that need to be attributed to dplyr, the functions that call deprecated functions, and better handle non-resolveable/ambiguous codes. For instance, if I supply the unit code "G", there are something like 72 matches. But I get an NA (reasonable) and a warning that "The following unit codes were not found: G" when the problem is not so much that they weren't found as that they weren't resolveable to a single unique park name.

RobLBaker · 2025-03-10T20:53:58Z

Overall, this looks pretty close! It would be nice to add some basic unit tests for the function.

…ames, many_names for codes with more than one corresponding park name added another example with missing value parameters added missing value parameters to function definition

…any park names populate those lists with unit codes based on size of ref_data variable added package designation for "mutate", use any_of() to get around deprecated select() function created two print statements: one prints all unique codes with no corresponding park names, one prints all unique codes with many corresponding park names

…ames, many_names for codes with more than one corresponding park name

…any park names

…_data variable

…precated select() function

…responding park names, one prints all unique codes with many corresponding park names

Merge branch 'master' of https://github.com/mdkompella/QCkitDev # Conflicts: # NEWS.md # R/get_park_names.R

Kompella and others added 8 commits March 10, 2025 12:02

created function to translate unit codes to names and add park name c…

9f4317e

…olumn to dataframe. added warning message if unit code not found. added proper roxygen documentation.

added another example

35f48ef

new function added to namespace

4e051c8

updated documentation

7a60561

changed to match tidyverse style

17f6468

updated website

968cbfe

updated documentation

15035dc

added function description to news file

93f1e7c

RobLBaker reviewed Mar 10, 2025

View reviewed changes

mdkompella added 12 commits March 11, 2025 08:38

added new parameters: no_names for codes with no corresponding park n…

3beea74

…ames, many_names for codes with more than one corresponding park name added another example with missing value parameters added missing value parameters to function definition

added new parameters: no_names for codes with no corresponding park n…

38300dc

…ames, many_names for codes with more than one corresponding park name

added another example with missing value parameters

ad6b78a

added missing value parameters to function definition, added line breaks

13d048c

created a separate list to populate with unit codes that resolve to m…

a0431b4

…any park names

populate no_names and many_names with unit codes based on size of ref…

f52af6b

…_data variable

added package designation for "mutate", use any_of() to get around de…

5c4f54d

…precated select() function

created two print statements: one prints all unique codes with no cor…

acdf4ac

…responding park names, one prints all unique codes with many corresponding park names

changed to match tiduverse style

df9d339

added function updates to news file

13329f0

add function to namespace

2512c72

mdkompella added 8 commits March 11, 2025 10:38

removed unmatched curly brace

85d37e3

Merge branch 'master' of https://github.com/mdkompella/QCkitDev # Conflicts: # NEWS.md # R/get_park_names.R

changed print statements to message

a8403f9

fixed another curly bracket

cf48c96

add function to docs index file

9121e99

updated documentation

8dcbe25

added unit tests

6b3f5a8

added dplyr package designation for filter function

45c6658

changed last update date

be58145

RobLBaker approved these changes Mar 13, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Function to translate park codes to park names #132

Function to translate park codes to park names #132

Uh oh!

mdkompella commented Mar 10, 2025

Uh oh!

RobLBaker left a comment

Uh oh!

RobLBaker Mar 10, 2025

Uh oh!

mdkompella Mar 10, 2025

Uh oh!

RobLBaker Mar 10, 2025

Uh oh!

RobLBaker Mar 10, 2025

Uh oh!

RobLBaker Mar 10, 2025 •

edited

Loading

Uh oh!

mdkompella Mar 10, 2025

Uh oh!

RobLBaker Mar 10, 2025 •

edited

Loading

Uh oh!

RobLBaker Mar 10, 2025

Uh oh!

RobLBaker Mar 10, 2025

Uh oh!

mdkompella Mar 11, 2025

Uh oh!

RobLBaker Mar 10, 2025

Uh oh!

RobLBaker commented Mar 10, 2025

Uh oh!

Uh oh!

Function to translate park codes to park names #132

Are you sure you want to change the base?

Function to translate park codes to park names #132

Uh oh!

Conversation

mdkompella commented Mar 10, 2025

Uh oh!

RobLBaker left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RobLBaker Mar 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RobLBaker Mar 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Was:

Now:

Was:

Now:

See https://tidyselect.r-lib.org/reference/faq-external-vector.html.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RobLBaker commented Mar 10, 2025

Uh oh!

Uh oh!

RobLBaker Mar 10, 2025 •

edited

Loading

RobLBaker Mar 10, 2025 •

edited

Loading

See
https://tidyselect.r-lib.org/reference/faq-external-vector.html.