New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

help(csvigo.load) doesn't work #8

Closed
zygmuntz opened this Issue Jan 16, 2015 · 3 comments

Comments

Projects
None yet
2 participants
@zygmuntz

zygmuntz commented Jan 16, 2015

th> help(csvigo.load)
undocumented symbol
[0.0006s]
th> help(csvigo.save)
undocumented symbol
[0.0006s]
th> help(randn)
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
help(symbol)

get inline help on a specific symbol

to browse the complete html documentation, call: browse()
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

@soumith

This comment has been minimized.

Show comment
Hide comment
@soumith

soumith Jan 16, 2015

Collaborator

yes it seems to not working. will work on fixing this.

Pulling the help from code:

      'csvigo.load',
      'Load a CSV file, according to the specifided mode:\n'
      .. ' - raw   : no clean up, return a raw list of lists, a 1-to-1 mapping to the CSV file\n'
      .. ' - tidy  : return a clean table, where each entry is a variable that points to its values\n'
      .. ' - query : return the tidy table, as well as query operators',
      {arg='path',      type='string',  help='path to file', req=true},
      {arg='separator', type='string',  help='separator (one character)', default=','},
      {arg='mode',      type='string',  help='load mode: raw | tidy | query', default='tidy'},
      {arg='header',    type='boolean', help='file has a header (variable names)', default=true},
      {arg='verbose',   type='boolean', help='verbose load', default=true},
      {arg='skip',      type='number',  help='skip this many lines at start of file', default=0}
   )

 'query',
            'This closure was automatically generated to query your data.\n'
            .. 'Example of query: query(\'union\', {var1={1}, var2={2,3,4}})\n'
            .. 'this query will return a subset of the original data, where var1 = 1 OR var2 = 2 or 3 or 4 \n'
            .. '\n'
            .. 'Other example of query: query(\'inter\', {var1={1}, var2={2,3,4}})\n'
            .. 'this query will return a subset of the original data, where var1 = 1 AND var2 = 2 or 3 or 4 \n'
            .. '\n'
            .. 'Other example of query: query(\'vars\')\n'
            .. 'this will return a list of the variable names\n'
            .. '\n'
            .. 'Other example of query: query() or query(\'all\')\n'
            .. 'this query will return the complete dataset'
            ,
            {arg='query',  type='string', help='query: all | help | vars | inter | union', default='all'},
            {arg='vars', type='table',  help='list of vars/vals'}

    'csvigo.save',
      'Load a CSV file, according to the specifided mode:\n'
      .. ' - raw   : no clean up, return a raw list of lists, a 1-to-1 mapping to the CSV file\n'
      .. ' - tidy  : return a clean table, where each entry is a variable that points to its values\n'
      .. ' - query : return the tidy table, as well as query operators',
      {arg='path',      type='string',  help='path to file', req=true},
      {arg='data',      type='table',   help='table to save as a CSV file', req=true},
      {arg='separator', type='string',  help='separator (one character)', default=','},
      {arg='mode',      type='string',  help='table to save is represented as: raw | tidy | query', default='autodetect'},
      {arg='header',    type='boolean', help='table has a header (variable names)', default=true},
      {arg='verbose',   type='boolean', help='verbose load', default=true}
Collaborator

soumith commented Jan 16, 2015

yes it seems to not working. will work on fixing this.

Pulling the help from code:

      'csvigo.load',
      'Load a CSV file, according to the specifided mode:\n'
      .. ' - raw   : no clean up, return a raw list of lists, a 1-to-1 mapping to the CSV file\n'
      .. ' - tidy  : return a clean table, where each entry is a variable that points to its values\n'
      .. ' - query : return the tidy table, as well as query operators',
      {arg='path',      type='string',  help='path to file', req=true},
      {arg='separator', type='string',  help='separator (one character)', default=','},
      {arg='mode',      type='string',  help='load mode: raw | tidy | query', default='tidy'},
      {arg='header',    type='boolean', help='file has a header (variable names)', default=true},
      {arg='verbose',   type='boolean', help='verbose load', default=true},
      {arg='skip',      type='number',  help='skip this many lines at start of file', default=0}
   )

 'query',
            'This closure was automatically generated to query your data.\n'
            .. 'Example of query: query(\'union\', {var1={1}, var2={2,3,4}})\n'
            .. 'this query will return a subset of the original data, where var1 = 1 OR var2 = 2 or 3 or 4 \n'
            .. '\n'
            .. 'Other example of query: query(\'inter\', {var1={1}, var2={2,3,4}})\n'
            .. 'this query will return a subset of the original data, where var1 = 1 AND var2 = 2 or 3 or 4 \n'
            .. '\n'
            .. 'Other example of query: query(\'vars\')\n'
            .. 'this will return a list of the variable names\n'
            .. '\n'
            .. 'Other example of query: query() or query(\'all\')\n'
            .. 'this query will return the complete dataset'
            ,
            {arg='query',  type='string', help='query: all | help | vars | inter | union', default='all'},
            {arg='vars', type='table',  help='list of vars/vals'}

    'csvigo.save',
      'Load a CSV file, according to the specifided mode:\n'
      .. ' - raw   : no clean up, return a raw list of lists, a 1-to-1 mapping to the CSV file\n'
      .. ' - tidy  : return a clean table, where each entry is a variable that points to its values\n'
      .. ' - query : return the tidy table, as well as query operators',
      {arg='path',      type='string',  help='path to file', req=true},
      {arg='data',      type='table',   help='table to save as a CSV file', req=true},
      {arg='separator', type='string',  help='separator (one character)', default=','},
      {arg='mode',      type='string',  help='table to save is represented as: raw | tidy | query', default='autodetect'},
      {arg='header',    type='boolean', help='table has a header (variable names)', default=true},
      {arg='verbose',   type='boolean', help='verbose load', default=true}
@zygmuntz

This comment has been minimized.

Show comment
Hide comment
@zygmuntz

zygmuntz commented Jan 17, 2015

Thanks.

@soumith

This comment has been minimized.

Show comment
Hide comment
@soumith

soumith Jan 17, 2015

Collaborator

you can also get the help by executing the csvigo functions with an empty argument.
csvigo.load()

Collaborator

soumith commented Jan 17, 2015

you can also get the help by executing the csvigo functions with an empty argument.
csvigo.load()

@zygmuntz zygmuntz closed this Dec 21, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment