search

ut-effectiveness / utDataStoR

https://ut-effectiveness.github.io/utDataStoR/
Other
0 stars 0 forks source link

Retire sql_fte function #44

Closed mkhassan-isu closed 3 days ago

mkhassan-isu commented 2 weeks ago

The function sql_fte should be renamed to make_fte_sql to maintain consistency with other similar functions in the package. However, to prevent breaking backward compatibility, we need to create a new function named make_fte_sql while keeping sql_fte intact. Additionally, a warning message will be added to sql_fte to inform users that this function will be deprecated in the future.

cdemkegit commented 2 weeks ago

lets add this line of code to the sql_fte function 

sql_fte <- function(data_source = 'Edify', name) {

  base <- system.file('sql', package='utDataStoR')

  file <- paste(
    base,
    '/',
    'fte',
    '/',
    'fte_off_edify.sql',
    sep = ''
  )

  fs::file_copy(
    file,
    here::here('sql', name))

warning("This function has been deprecated and is no longer supported. 
    Please use the 'make_fte_sql' function instead for improved functionality and support.")

}

We also need to rewrite the function to have the correct naming prefix.

andreabringhurst commented 3 days ago

@mkhassan-isu Can you let me know what pull request this is in. Then we can close it.

mkhassan-isu commented 3 days ago

@andreabringhurst Here is the pull request:

https://github.com/ut-effectiveness/utDataStoR/pull/43

andreabringhurst commented 3 days ago

I am closing this issue. It will be fixed when pull request #43 is approved.