Method data_label

pandas/io/stata.py:1963–1994

Return data label of Stata file. The data label is a descriptive string associated with the dataset stored in the Stata file. This property provides access to that label, if one is present. See Also -------- io.stata.StataReader.variable_lab

(self)

    @property
    def data_label(self) -> str:
        """
        Return data label of Stata file.

        The data label is a descriptive string associated with the dataset
        stored in the Stata file. This property provides access to that
        label, if one is present.

        See Also
        --------
        io.stata.StataReader.variable_labels : Return a dict associating each variable
            name with corresponding label.
        DataFrame.to_stata : Export DataFrame object to Stata dta format.

        Examples
        --------
        >>> df = pd.DataFrame([(1,)], columns=["variable"])
        >>> time_stamp = pd.Timestamp(2000, 2, 29, 14, 21)
        >>> data_label = "This is a data file."
        >>> path = "/My_path/filename.dta"
        >>> df.to_stata(
        ...     path,
        ...     time_stamp=time_stamp,  # doctest: +SKIP
        ...     data_label=data_label,  # doctest: +SKIP
        ...     version=None,
        ... )  # doctest: +SKIP
        >>> with pd.io.stata.StataReader(path) as reader:  # doctest: +SKIP
        ...     print(reader.data_label)  # doctest: +SKIP
        This is a data file.
        """
        self._ensure_open()
        return self._data_label

    @property
    def time_stamp(self) -> str: