draft of Issue

[miyer26]

Submitting Author: Mukund Iyer (@miyer26)
Package Name: magmaviz One-Line Description of Package: Makes EDA easy by providing functions for four common types of plots with the magma color scheme. Repository Link: https://github.com/UBC-MDS/magmaviz Version submitted: 0.3.9
Editor: Mohammed Abdul Moid (@iamMoid), Irene Yang (@shyan0903), Rubén De la Garza Macías (@ruben1dlg lg), Mukund Iyer (@miyer26) Reviewer 1: Yair Guterman
Reviewer 2: Giang Nguyen Reviewer 3: Daniel King Archive: TBD
Version accepted: TBD

---

Description

This package aims to make Exploratory Data Analysis easy by providing python plot functions based on the Altair library to plot four common types of plots with the magma color scheme. To maximize interpretability, the plots have defined color schemes (discrete, diverging, sequential) based on the kind of data they show and additional inputs for customizability.

Scope

• Please indicate which category or categories this package falls under:
  • [ ] Data retrieval
  • [ ] Data extraction
  • [ ] Data munging
  • [ ] Data deposition
  • [ ] Reproducibility
  • [ ] Geospatial
  • [ ] Education
  • [x] Data visualization*

* Please fill out a pre-submission inquiry before submitting a data visualization package. For more info, see notes on categories of our guidebook.

• Explain how the and why the package falls under these categories (briefly, 1-2 sentences):

This package has functions with the sole objective of creating plots promptly and easily based on the 'Altair' package using the magma color scheme.

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

This package is designed to be used by data scientists who are exploring data or developing a visual dashboard. The package is versatile and can be used for most data science projects.

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

Similar packages to ours include deneb, which uses Altair, and spartan-viz, which uses Matplotlib. These also streamline the EDA process but do not use the Magma theme and functionalities that this package offers.

• 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:

Technical checks

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

• [x] does not violate the Terms of Service of any service it interacts with.
• [x] has an OSI approved license.
• [x] contains a README with instructions for installing the development version.
• [x] includes documentation with examples for all functions.
• [x] contains a vignette with examples of its essential functions and uses.
• [x] has a test suite.
• [x] has continuous integration, such as Travis CI, AppVeyor, 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][JossSubmissionRequirements]. 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][JossSubmissionRequirements]: "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][JossPaperRequirements] 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: Do not submit your package separately to JOSS*

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.

• [x] 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.

Code of conduct

• [x] I agree to abide by pyOpenSci's Code of Conduct during the review process and in maintaining my package should it be accepted.

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

Editor and Review Templates

Editor and review templates can be found here

[miyer26]

Please let me know if you want me to make any changes!