Great Tables submission

[rich-iannone]

Submitting Author: Name (@rich-iannone)
All current maintainers: (@rich-iannone, @machow)
Package Name: Great Tables
One-Line Description of Package: Make awesome display tables using Python.
Repository Link: https://github.com/posit-dev/great-tables
Version submitted: v0.9.0
EiC: @Batalex
Editor: @Batalex
Reviewer 1: TBD
Reviewer 2: TBD
Archive: TBD
JOSS DOI: TBD
Version accepted: TBD
Date accepted (month/day/year): TBD

---

Code of Conduct & Commitment to Maintain Package

• I agree to abide by pyOpenSci's Code of Conduct during the review process and in maintaining my package after should it be accepted.
• I have read and will commit to package maintenance after the review as per the pyOpenSci Policies Guidelines.

Description

The Great Tables package is all about creating tables for the purpose of presentation. You can use
Pandas or Polars DataFrames as inputs, and the Great Tables API allows you to:

• structure the data using column spanners and row groups, and add header and footer information
• format the data with a wide range of powerful formatting methods
• style the table to make it aesthetically pleasing or to highlight important information
• integrate the table display into notebooks, Quarto documents or web pages, and export the table
  as HTML or a variety of image formats

Scope

• Please indicate which category or categories.
  Check out our package scope page to learn more about our
  scope. (If you are unsure of which category you fit, we suggest you make a pre-submission inquiry):

  • Data retrieval
  • Data extraction
  • Data processing/munging
  • Data deposition
  • Data validation and testing
  • Data visualization¹
  • [] Workflow automation
  • Citation management and bibliometrics
  • Scientific software wrappers
  • Database interoperability

Domain Specific

• Geospatial
• Education

Community Partnerships

If your package is associated with an
existing community please check below:

• Astropy:My package adheres to Astropy community standards
• Pangeo: My package adheres to the Pangeo standards listed in the pyOpenSci peer review guidebook

• For all submissions, explain how and why the package falls under the categories you indicated above. In your explanation, please address the following points (briefly, 1-2 sentences for each):

The package can be seen as a data visualization package, but it is perhaps more in the direction of data presentation/publication (i.e., not datavis in the traditional sense). However, tables are important and they are ubiquitous in all sorts of scientific publications.

• Who is the target audience and what are scientific applications of this package?

The target audience is anyone who needs to present data in the tabular format. There is a particular focus on science and engineering applications as many of the formatting methods are geared toward this audience (e.g., scientific notation, significant figures, units notation, chemistry notation, etc.).

• Are there other Python packages that accomplish the same thing? If so, how does yours differ?

There are only a few packages that deal with tabular data presentation. The Pandas styler API is probably the best known of these, but it is limited in its capabilities. A big part of Great Tables is the ability to structure a table to a more traditional table format (one you'd commonly see in journals or reports) instead of interactive tables that are more common in web apps (i.e., displaying hundreds or thousands of rows of data). The formatting capabilities of Great Tables are also much more extensive than Pandas styler or other packages.

• If you made a pre-submission enquiry, please paste the link to the corresponding issue, forum post, or other discussion, or @tag the editor you contacted:

#184

Technical checks

For details about the pyOpenSci packaging requirements, see our packaging guide. Confirm each of the following by checking the box. This package:

• does not violate the Terms of Service of any service it interacts with.
• uses an OSI approved license.
• contains a README with instructions for installing the development version.
• includes documentation with examples for all functions.
• contains a tutorial with examples of its essential functions and uses.
• has a test suite.
• has continuous integration setup, such as GitHub Actions CircleCI, and/or others.

Publication Options

• Do you wish to automatically submit to the Journal of Open Source Software? If so:

JOSS Checks

• The package has an obvious research application according to JOSS's definition in their submission requirements. Be aware that completing the pyOpenSci review process does not guarantee acceptance to JOSS. Be sure to read their submission requirements (linked above) if you are interested in submitting to JOSS.
• The package is not a "minor utility" as defined by JOSS's submission requirements: "Minor ‘utility’ packages, including ‘thin’ API clients, are not acceptable." pyOpenSci welcomes these packages under "Data Retrieval", but JOSS has slightly different criteria.
• The package contains a paper.md matching JOSS's requirements with a high-level description in the package root or in inst/.
• The package is deposited in a long-term repository with the DOI:

Note: JOSS accepts our review as theirs. You will NOT need to go through another full review. JOSS will only review your paper.md file. Be sure to link to this pyOpenSci issue when a JOSS issue is opened for your package. Also be sure to tell the JOSS editor that this is a pyOpenSci reviewed package once you reach this step.

Are you OK with Reviewers Submitting Issues and/or pull requests to your Repo Directly?

This option will allow reviewers to open smaller issues that can then be linked to PR's rather than submitting a more dense text based review. It will also allow you to demonstrate addressing the issue via PR links.

• Yes I am OK with reviewers submitting requested changes as issues to my repo. Reviewers will then link to the issues in their submitted review.

Confirm each of the following by checking the box.

• I have read the author guide.
• I expect to maintain this package for at least 2 years and can help find a replacement for the maintainer (team) if needed.

Please fill out our survey

• Last but not least please fill out our pre-review survey. This helps us track
  submission and improve our peer review process. We will also ask our reviewers
  and editors to fill this out.

P.S. Have feedback/comments about our review process? Leave a comment here

Editor and Review Templates

The editor template can be found here.

The review template can be found here.

Footnotes

1. Please fill out a pre-submission inquiry before submitting a data visualization package. ↩

[Batalex]

Editor in Chief checks

Hi there! Thank you for submitting your package for pyOpenSci review. Below are the basic checks that your package needs to pass to begin our review. If some of these are missing, we will ask you to work on them before the review process begins.

Please check our Python packaging guide for more information on the elements
below.

• Installation The package can be installed from a community repository such as PyPI (preferred), and/or a community channel on conda (e.g. conda-forge, bioconda).
  • The package imports properly into a standard Python environment import package.
• Fit The package meets criteria for fit and overlap.
• Documentation The package has sufficient online documentation to allow us to evaluate package function and scope without installing the package. This includes:
  • User-facing documentation that overviews how to install and start using the package.
  • Short tutorials that help a user understand how to use the package and what it can do for them.
  • API documentation (documentation for your code's functions, classes, methods and attributes): this includes clearly written docstrings with variables defined using a standard docstring format.
• Core GitHub repository Files
  • README The package has a README.md file with clear explanation of what the package does, instructions on how to install it, and a link to development instructions.
  • Contributing File The package has a CONTRIBUTING.md file that details how to install and contribute to the package.
  • Code of Conduct The package has a CODE_OF_CONDUCT.md file.
  • License The package has an OSI approved license.
    NOTE: We prefer that you have development instructions in your documentation too.
• Issue Submission Documentation All of the information is filled out in the YAML header of the issue (located at the top of the issue template).
• Automated tests Package has a testing suite and is tested via a Continuous Integration service.
• Repository The repository link resolves correctly.
• Package overlap The package doesn't entirely overlap with the functionality of other packages that have already been submitted to pyOpenSci.
• Archive (JOSS only, may be post-review): The repository DOI resolves correctly.
• Version (JOSS only, may be post-review): Does the release version given match the GitHub release (v1.0.0)?

---

• Initial onboarding survey was filled out
  We appreciate each maintainer of the package filling out this survey individually. 🙌
  Thank you authors in advance for setting aside five to ten minutes to do this. It truly helps our organization. 🙌

---

---

Editor comments

This is a really solid submission, and I am super excited for us to contribute to great_tables. I'll get started on finding an editor for this submission.

suggestion: TIL we can store CONTRIBUTING.md in .github. Would you mind adding a section in the README pointing to this file? I knew what I was looking for, but I think the entry barrier for new contributors would be lower if they did not have to open a PR to see the contributing guidelines.

todo: We can get started, but during the review's course, we should add the paper.md file as part of the review.

[cmarmo]

Hi @rich-iannone, thanks again for submitting Great Tables to pyOpenSci!
I'm Chiara and I'm following up as editor in chief for the next three months.
I'm glad to announce that @Batalex is volounteering to serve as editor too for your submission.... Thanks a lot Alex!

[Batalex]

Hello there @rich-iannone,
I have been looking for reviewers for this submission, but as you might guess, the summer period is slowing down all kinds of interactions. Nonetheless, this submission is still alive and well!