ó
áp7]c           @   sb   d  Z  d d l m Z d Z d Z e  Z d Z d Z d Z	 d Z
 d d	 „ Z d
 „  Z d „  Z d S(   s   Travel Mode Choiceiÿÿÿÿ(   t   utilst   restructuredtexts   This is public domain.s€  
Greene, W.H. and D. Hensher (1997) Multinomial logit and discrete choice models
in Greene, W. H. (1997) LIMDEP version 7.0 user's manual revised, Plainview,
New York econometric software, Inc.
Download from on-line complements to Greene, W.H. (2011) Econometric Analysis,
Prentice Hall, 7th Edition (data table F18-2)
http://people.stern.nyu.edu/wgreene/Text/Edition7/TableF18-2.csv
s@   Data used to study travel mode choice between Australian cities
sC  The data, collected as part of a 1987 intercity mode choice
study, are a sub-sample of 210 non-business trips between Sydney, Canberra and
Melbourne in which the traveler chooses a mode from four alternatives (plane,
car, bus and train). The sample, 840 observations, is choice based with
over-sampling of the less popular modes (plane, train and bus) and under-sampling
of the more popular mode, car. The level of service data was derived from highway
and transport networks in Sydney, Melbourne, non-metropolitan N.S.W. and Victoria,
including the Australian Capital Territory.sô  ::

    Number of observations: 840 Observations On 4 Modes for 210 Individuals.
    Number of variables: 8
    Variable name definitions::

        individual = 1 to 210
        mode =
            1 - air
            2 - train
            3 - bus
            4 - car
        choice =
            0 - no
            1 - yes
        ttme = terminal waiting time for plane, train and bus (minutes); 0
               for car.
        invc = in vehicle cost for all stages (dollars).
        invt = travel time (in-vehicle time) for all stages (minutes).
        gc = generalized cost measure:invc+(invt*value of travel time savings)
            (dollars).
        hinc = household income ($1000s).
        psize = traveling group size in mode chosen (number).c         C   s   t  j t ƒ  d |  ƒS(   sn  
    Load the data modechoice data and return a Dataset class instance.

    Parameters
    ----------
    as_pandas : bool
        Flag indicating whether to return pandas DataFrames and Series
        or numpy recarrays and arrays.  If True, returns pandas.

    Returns
    -------
    Dataset instance:
        See DATASET_PROPOSAL.txt for more information.
    t	   as_pandas(   t   dut   as_numpy_datasett   load_pandas(   R   (    (    sC   lib/python2.7/site-packages/statsmodels/datasets/modechoice/data.pyt   load6   s    c          C   s4   t  ƒ  }  t j |  d d d d d d d d d	 g ƒS(
   s²   
    Load the data modechoice data and return a Dataset class instance.

    Returns
    -------
    Dataset instance:
        See DATASET_PROPOSAL.txt for more information.
    t	   endog_idxi   t   exog_idxi   i   i   i   i   i   (   t	   _get_dataR   t   process_pandas(   t   data(    (    sC   lib/python2.7/site-packages/statsmodels/datasets/modechoice/data.pyR   H   s    		c           C   s   t  j t d d d d t ƒS(   Ns   modechoice.csvt   sept   ;t   convert_float(   R   t   load_csvt   __file__t   True(    (    (    sC   lib/python2.7/site-packages/statsmodels/datasets/modechoice/data.pyR	   U   s    N(   t   __doc__t   statsmodels.datasetsR    R   t   __docformat__t	   COPYRIGHTt   TITLEt   SOURCEt
   DESCRSHORTt	   DESCRLONGt   NOTEt   NoneR   R   R	   (    (    (    sC   lib/python2.7/site-packages/statsmodels/datasets/modechoice/data.pyt   <module>   s   		