Skip to content

Commit

Permalink
documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Ron Thompson committed Jun 13, 2018
1 parent ee485b0 commit cd00bd3
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions koalas/frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ def __getitem__(cls, item):
def __init__(self, data=None, columns=None, query=None, file=None):
"""
Ok so bad way of doing this right now, but it works, so stop complaining
Parameters
----------
data : list of tuples, lists, or dicts
columns : list of str
query : str
file : str
Path on DBFS or cluster for a parquet file
"""
if data:
self.__frame = spark.createDataFrame(data, columns)
Expand All @@ -29,6 +37,10 @@ def __init__(self, data=None, columns=None, query=None, file=None):
def read_sql_query(cls, query=None):
"""
Read a sql query into a dataframe
Parameters
----------
query : str
"""
return cls(query=query)

Expand Down Expand Up @@ -57,4 +69,8 @@ def filter(self, params):
return self.__frame.where(params)

def describe(self):
"""
This is super sluggish right now, need to figure out performance
enhancement
"""
return self.__frame.describe()

0 comments on commit cd00bd3

Please sign in to comment.