B
    Z8                 @   s`   d Z dZdZe ZdZdZdZdZddlZ	dd	l
mZ dd
lmZmZ dd Zdd Zdd ZdS )zTravel Mode ChoiceZrestructuredtextzThis is public domain.a  
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
z@Data used to study travel mode choice between Australian cities
aC  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.a  ::

    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).    N)utils)dirnameabspathc           	   C   s$   t  } tj| dddddddgtdS )	z
    Load the data modechoice data and return a Dataset class instance.

    Returns
    -------
    Dataset instance:
        See DATASET_PROPOSAL.txt for more information.
                         )	endog_idxexog_idxdtype)	_get_dataduZprocess_recarrayfloat)data r   Clib/python3.7/site-packages/statsmodels/datasets/modechoice/data.pyload;   s    	r   c           	   C   s$   t  } tj| dddddddgtdS )	z
    Load the data modechoice data and return a Dataset class instance.

    Returns
    -------
    Dataset instance:
        See DATASET_PROPOSAL.txt for more information.
    r   r   r   r   r	   r
   r   )r   r   r   )r   r   Zprocess_recarray_pandasr   )r   r   r   r   load_pandasH   s    
r   c           	   C   s<   t tt} t| d d}tj|ddtd}W d Q R X |S )Nz/modechoice.csvrb;T)Z	delimiternamesr   )r   r   __file__opennpZ
recfromtxtr   )filepathfr   r   r   r   r   V   s    r   )__doc__Z__docformat__Z	COPYRIGHTZTITLEZSOURCEZ
DESCRSHORTZ	DESCRLONGZNOTEZnumpyr   Zstatsmodels.datasetsr   r   os.pathr   r   r   r   r   r   r   r   r   <module>   s   	