tests/testthat/_snaps/labels.md

In DanChaltiel/crosstable: Crosstables for Descriptive Analyses

Labelling dataframes

Code
  get_label(xx)
Output
                      model                       mpg                       cyl 
                    "Model"       "Miles/(US) gallon"                     "cyl" 
                       disp                        hp                      drat 
    "Displacement (cu.in.)"        "Gross horsepower"         "Rear axle ratio" 
                         wt                      qsec                        vs 
        "Weight (1000 lbs)"           "1/4 mile time"                  "Engine" 
                         am                      gear                      carb 
             "Transmission" "Number of forward gears"   "Number of carburetors" 
                    hp_date                qsec_posix 
       "Some nonsense date"               "Date+time"

Labelling nested lists (get)

Code
  get_label(x)
Output

                         NA                        NA                        NA 
          iris.Sepal.Length          iris.Sepal.Width         iris.Petal.Length 
          "Length of Sepal"          "Width of Sepal"         "Length of Petal" 
           iris.Petal.Width              iris.Species                     model 
           "Width of Petal"                  "Specie"                   "Model" 
                        mpg                       cyl                      disp 
        "Miles/(US) gallon"     "Number of cylinders"   "Displacement (cu.in.)" 
                         hp                      drat                        wt 
         "Gross horsepower"         "Rear axle ratio"       "Weight (1000 lbs)" 
                       qsec                        vs                        am 
            "1/4 mile time"                  "Engine"            "Transmission" 
                       gear                      carb                   hp_date 
  "Number of forward gears"   "Number of carburetors"      "Some nonsense date" 
                 qsec_posix                       foo                      ffoo 
                "Date+time"                     "foo"                    "ffoo"

Code
  get_label(x, simplify = FALSE)
Output
  [[1]]
  [1] NA NA NA

  [[2]]
          iris.Sepal.Length          iris.Sepal.Width         iris.Petal.Length 
          "Length of Sepal"          "Width of Sepal"         "Length of Petal" 
           iris.Petal.Width              iris.Species                     model 
           "Width of Petal"                  "Specie"                   "Model" 
                        mpg                       cyl                      disp 
        "Miles/(US) gallon"     "Number of cylinders"   "Displacement (cu.in.)" 
                         hp                      drat                        wt 
         "Gross horsepower"         "Rear axle ratio"       "Weight (1000 lbs)" 
                       qsec                        vs                        am 
            "1/4 mile time"                  "Engine"            "Transmission" 
                       gear                      carb                   hp_date 
  "Number of forward gears"   "Number of carburetors"      "Some nonsense date" 
                 qsec_posix 
                "Date+time"

  [[3]]
     foo   ffoo 
   "foo" "ffoo"

clean_names_with_labels

Code
  x = data.frame(`name with space` = 1, TwoWords = 1, `total $ (2009)` = 1,
    àccénts = 1, check.names = FALSE)
  cleaned = clean_names_with_labels(x)
  names(cleaned)
Output
  [1] "name_with_space" "twowords"        "total_2009"      "accents"        
Code
  get_label(cleaned)
Output
    name_with_space          twowords        total_2009           accents 
  "name with space"        "TwoWords"  "total $ (2009)"         "àccénts" 
Code
  cleaned = clean_names_with_labels(x, except = "name with space")
  names(cleaned)
Output
  [1] "name with space" "twowords"        "total_2009"      "accents"        
Code
  get_label(cleaned)
Output
    name with space          twowords        total_2009           accents 
  "name with space"        "TwoWords"  "total $ (2009)"         "àccénts"

rename_dataframe_with_labels

Code
  rename_with_labels(dat) %>% names()
Output
  [1] "Model"                 "Miles/(US) gallon"     "Number of cylinders"  
  [4] "Displacement (cu.in.)" "Gross horsepower"     
Code
  rename_with_labels(dat, except = 5) %>% names()
Output
  [1] "Model"                 "Miles/(US) gallon"     "Number of cylinders"  
  [4] "Displacement (cu.in.)" "hp"                   
Code
  rename_with_labels(dat, except = hp) %>% names()
Output
  [1] "Model"                 "Miles/(US) gallon"     "Number of cylinders"  
  [4] "Displacement (cu.in.)" "hp"                   
Code
  rename_with_labels(dat, except = "hp") %>% names()
Output
  [1] "Model"                 "Miles/(US) gallon"     "Number of cylinders"  
  [4] "Displacement (cu.in.)" "hp"                   
Code
  rename_with_labels(dat, except = 99) %>% names()
Output
  [1] "Model"                 "Miles/(US) gallon"     "Number of cylinders"  
  [4] "Displacement (cu.in.)" "Gross horsepower"

DanChaltiel/crosstable documentation built on Jan. 23, 2025, 10:10 a.m.