convert.to.sul.Rd 658 B

12345678910111213141516171819202122232425
  1. % Generated by roxygen2: do not edit by hand
  2. % Please edit documentation in R/sul.R
  3. \name{convert.to.sul}
  4. \alias{convert.to.sul}
  5. \title{Peform SUL calculation}
  6. \usage{
  7. convert.to.sul(x, var, sulVar, genderVar = "gender", bmiVar = "bmi")
  8. }
  9. \arguments{
  10. \item{x}{a data frame that contains var, genderVar and bmi columns}
  11. \item{var}{a variable measured in SUV that should be converted to SUL}
  12. \item{sulVar}{target variable to store converted values}
  13. \item{genderVar}{a variable denoting gender (1=female, 2=male)}
  14. \item{bmiVar}{a variable with body mass index values}
  15. }
  16. \value{
  17. data frame x with added sulVar column
  18. }
  19. \description{
  20. Peform SUL calculation
  21. }