info

Retrieve information about Haver Analytics variables

collapse all in page

    Syntax

    data = info(c,variable)
    [data,response] = info(c,variable)

    Description

    data = info(c,variable) returns a structure containing information about the specified Haver Analytics® variable, where c is a haver, haverdirect, or haverview connection object.

    example

    [data,response] = info(c,variable) returns a table containing variable information and a response message for a haverview connection object.

    example

    Examples

    collapse all

    Using a haver connection, retrieve information about a variable.

    Establish a haver connection c.

    c = haver('d:\work\haver\data\haverd.dat');

    Request information for the variable FFED2. The variable data is a structure with a field for each piece of information.

    variable = "FFED2";
data = info(c,variable)

    data = 

  struct with fields:

     VarName: 'FFED2'
   StartDate: '01-Jan-1991'
     EndDate: '31-Dec-1998'
   NumberObs: 2088
   Frequency: 'D'
 DateTimeMod: '02-Apr-2007 20:46:37' 
   Magnitude: 0
DecPrecision: 2
     DifType: 1
     AggType: 'AVG'
    DataType: '%'
       Group: 'Z05'
      Source: 'FRB'
  Descriptor: 'Federal Funds [Effective] Rate (% p.a.)'
 ShortSource: 'History'
  LongSource: 'Historical Series'

    Close the haver connection.

    close(c);

    Using a haver connection, retrieve information about a variable. Return information as a table.

    Establish a haver connection c.

    c = haver('d:\work\haver\data\haverd.dat');

    Set the data return format to a table using the DataReturnFormat property of the haver object.

    c.DataReturnFormat = 'table';

    Request information for the variable ABQ. The variable ABQ provides bankruptcy filings in the US. The output data is a table with a variable for each piece of information.

    variable = "ABQ";
data = info(c,variable)
    data =

  1×16 table

    VarName      StartDate         EndDate       NumberObs    Frequency         DateTimeMod          Magnitude    DecPrecision    DifType    AggType    DataType    Group    Source                   Descriptor                   ShortSource                    LongSource                
    _______    _____________    _____________    _________    _________    ______________________    _________    ____________    _______    _______    ________    _____    ______    ________________________________________    ___________    __________________________________________

     'ABQ'     '01-Jan-1980'    '01-Jan-2015'     141.00         'Q'       '28-Apr-2015 16:21:22'      0.00           0.00         0.00       'SUM'     'Units'     'C13'    'USC'     'Total Bankruptcy Filings, U.S. (Units)'    'USCOURTS'     'Administrative Office of the U.S. Courts'

    Close the haver connection.

    close(c);

    Using a haver connection, retrieve information about a variable. Return dates as datetime arrays.

    Establish a haver connection c.

    c = haver('d:\work\haver\data\haverd.dat');

    Set the date and time format to a datetime array by using the DatetimeType property of the haver object.

    c.DatetimeType = 'datetime';

    Request information for the variable ABQ. The variable ABQ provides bankruptcy filings in the US.

    variable = "ABQ";
data = info(c,variable)
    data = 

  struct with fields:

         VarName: 'ABQ'
       StartDate: 01-Jan-1980
         EndDate: 01-Jan-2015
       NumberObs: 141.00
       Frequency: 'Q'
     DateTimeMod: 28-Apr-2015 16:21:22
       Magnitude: 0
    DecPrecision: 0
         DifType: 0
         AggType: 'SUM'
        DataType: 'Units'
           Group: 'C13'
          Source: 'USC'
      Descriptor: 'Total Bankruptcy Filings, U.S. (Units)'
     ShortSource: 'USCOURTS'
      LongSource: 'Administrative Office of the U.S. Courts'

    data is a structure with a field for each piece of information. The dates are datetime arrays.

    Close the haver connection.

    close(c);

    Create a haverview connection using a valid authentication token and database name. In this example, replace 681b61cf-dc7d-4698-a168-74c79b0c1a04 with your authentication token and replace USECON with the name of your database.

    token = "681b61cf-dc7d-4698-a168-74c79b0c1a04";
databasename = "USECON";
c = haverview(token,databasename)
    c = 
    
  haverview with properties:
    
    DatabaseName: "USECON"
         TimeOut: 200.00

    Retrieve a table containing information about the haverview variable. In this example, replace ABQ with the name of your variable.

    variable = "ABQ";
[data,response] = info(c,variable)
    data =
    
  1×19 table

     name      databaseName    datetimeLastModified    startingPeriod    dataPointCount    frequency    magnitude    decimalPrecision    differenceType    aggregationType    dataType     groupName    shortSourceName                     sourceName                                    description                    geography    geography2    startDate    originalFrequency
    _______    ____________    ____________________    ______________    ______________    _________    _________    ________________    ______________    _______________    _________    _________    _______________    ____________________________________________    __________________________________________    _________    __________    _________    _________________

    {'ABQ'}     {'USECON'}        1690896466.00            276.00            174.00          30.00        0.00             0.00               0.00              2.00          {'Units'}     {'C13'}      {'USCOURTS'}      {'Administrative Office of the U.S. Courts'}    {'Total Bankruptcy Filings, U.S. (Units)'}     {'111'}     {0×0 char}     801.00            30.00

    Input Arguments

    collapse all

    Haver Analytics connection, specified as a haver, haverdirect, or haverview connection object.

    Haver Analytics variable, specified as a character vector, string scalar, cell array of character vectors, or string array to denote which historical data to retrieve.

    Example: "FFED"

    Data Types: char | string | cell

    Output Arguments

    collapse all

    Variable information, returned as a structure for the first syntax or as a table for the second syntax.

    HTTP request response, returned as a ResponseMessage object for haverview input connection objects. For details, see matlab.net.http.ResponseMessage.

    Version History

    Introduced in R2007a

    See Also

    | | | | |

    Topics