Skip to content
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

Add examples of using BIOM #3

Closed
wasade opened this issue Apr 16, 2012 · 12 comments
Closed

Add examples of using BIOM #3

wasade opened this issue Apr 16, 2012 · 12 comments
Assignees

Comments

@wasade
Copy link
Member

wasade commented Apr 16, 2012

Add examples (in doctest?) of using BIOM objects

@wasade
Copy link
Member Author

wasade commented May 30, 2012

ping people in lab for examples, leave unstructured right now, push for doctest use within 1.1

@ghost ghost assigned wasade May 30, 2012
@gregcaporaso
Copy link
Contributor

added a quick example of table_factory in the table_factory doc string.

@jairideout
Copy link
Member

@wasade and I discussed this and are moving it to 1.2.0 since we have limited time before the release and not many devs have been asking about how to use these classes.

ElDeveloper added a commit to ElDeveloper/biom-format that referenced this issue Apr 30, 2014
@wasade
Copy link
Member Author

wasade commented May 14, 2014

@antgonza, do you have bandwidth to work on examples?

@wasade
Copy link
Member Author

wasade commented May 14, 2014

Specifically, it would be ideal to have examples of:

  • Constructing tables with Table
  • Table.exists
  • Table.filter
  • Table.norm
  • Table.transform
  • Table.sort
  • Table.metadata
  • Table.sum
  • Table.reduce
  • Table.iter
  • Table.merge
  • Table.collapse
  • Table.partition
  • Table.iter_data

What we need, also ideally, are examples in the method docstrings, and a coherent module level docstring for biom.table. Of the above, I think an example at the module level of the following would likely get people generally oriented:

  • create a Table
  • normalize the Table
  • filter the Table
  • summarize the Table in some interesting fashion

@antgonza antgonza assigned antgonza and unassigned wasade May 14, 2014
@ElDeveloper
Copy link
Member

While working on #383 I realized that this issue is not going to be properly rendered if the numpydoc sphinx extension is not present.

@wasade
Copy link
Member Author

wasade commented May 14, 2014

@ElDeveloper, could you create an issue for including numpydoc please?

@ElDeveloper
Copy link
Member

#277 should serve as that issue.

@wasade
Copy link
Member Author

wasade commented May 15, 2014

Just to make a note, I'm going to start working on the module level docstring

@ElDeveloper
Copy link
Member

I'll take merge.

@teravest
Copy link
Contributor

I'll finish out the list with collapse

@ElDeveloper
Copy link
Member

w04zofd

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

No branches or pull requests

6 participants