Documentation Center

  • Trial Software
  • Product Updates

droplevels

Class: categorical

The nominal and ordinal array data types might be removed in a future release. To represent ordered and unordered discrete, nonnumeric data, use the MATLAB® categorical data type instead.

Syntax

B = droplevels(A)
B = droplevels(A,oldlevels)

Description

B = droplevels(A) removes unused levels from the categorical array A. B is a categorical array with the same size and values as A, but with a list of potential levels that includes only those present in some element of A.

B = droplevels(A,oldlevels) removes specified levels from the categorical array A. oldlevels is a cell array of strings or a 2-D character matrix specifying the levels to be removed.

droplevels removes levels, but does not remove elements. Elements of B that correspond to elements of A having levels in oldlevels all have an undefined level.

Examples

Example 1

Drop unused age levels from the data in hospital.mat:

load hospital
edges = 0:10:100;
labels = strcat(num2str((0:10:90)','%d'),{'s'});
AgeGroup = ordinal(hospital.Age,labels,[],edges);
AgeGroup = droplevels(AgeGroup);
getlabels(AgeGroup)
ans = 
    '20s'    '30s'    '40s'    '50s'

Example 2

  1. Load patient data from the CSV file hospital.dat and store the information in a dataset array with observation names given by the first column in the data (patient identification):

    patients = dataset('file','hospital.dat',...
                       'delimiter',',',...
                       'ReadObsNames',true);
    
  2. Make the {0,1}-valued variable smoke nominal, and change the labels to 'No' and 'Yes':

    patients.smoke = nominal(patients.smoke,{'No','Yes'});
    
  3. Add new levels to smoke as placeholders for more detailed histories of smokers:

    patients.smoke = addlevels(patients.smoke,...
                     {'0-5 Years','5-10 Years','LongTerm'});
    
  4. Assuming the nonsmokers have never smoked, relabel the 'No' level:

    patients.smoke = setlabels(patients.smoke,'Never','No');
    
  5. Drop the undifferentiated 'Yes' level from smoke:

    patients.smoke = droplevels(patients.smoke,'Yes');
    
    Warning: OLDLEVELS contains categorical levels that 
    were present in A, caused some array elements to have 
    undefined levels.

    Note that smokers now have an undefined level.

  6. Set each smoker to one of the new levels, by observation name:

    patients.smoke('YPL-320') = '5-10 Years';

See Also

| | | |

Was this topic helpful?