civis.io.file_to_dataframe¶
-
civis.io.
file_to_dataframe
(file_id, compression='infer', client=None, **read_kwargs)[source]¶ Load a
DataFrame
from a CSV stored in a Civis FileThe
DataFrame
will be read directly from Civis without copying the CSV to a local file on disk.Parameters: - file_id : int
ID of a Civis File which contains a CSV
- compression : str, optional
If “infer”, set the
compression
argument ofpandas.read_csv
based on the file extension of the name of the Civis File. Otherwise pass this argument topandas.read_csv
.- client :
civis.APIClient
, optional If not provided, an
civis.APIClient
object will be created from theCIVIS_API_KEY
.- **read_kwargs
Additional arguments will be passed directly to
read_csv()
.
Returns: - :class:`~pandas.DataFrame` containing the contents of the CSV
Raises: - ImportError
If
pandas
is not available
See also