Submission: RDataPeek

[moniquewong]

Submitting Author: Monique Wong (@moniquewong) Repository: https://github.com/UBC-MDS/RDataPeek Version submitted: 1.1.1 Editor: @ kvarada (delete space to tag Varada) Reviewer 1: @cgostic Reviewer 2: @HanyingZhang Archive: TBD Version accepted: TBD

---

Package: RDataPeek
Title: Generates a Visual Summary of a Dataset
Version: 0.0.0.9000
Authors@R: 
    c(person(given = "Alistair",
           family = "Clark",
           role = c("aut", "cre", "ctb", "cph"),
           email = "alistair.jl.clark@gmail.com"),
       person(given = "Shangjing",
           family = "Hu",
           role = c("aut", "ctb", "cph")),
        person(given = "Thomas",
           family = "Pin",
           role = c("aut", "ctb", "cph")),
        person(given = "Monique",
           family = "Wong",
           role = c("aut", "ctb", "cph")))
Description: RDataPeek is a package that enables data scientists to efficiently generate a visual summary of a dataset. This package includes functions that show the size of the dataset, a visual summary of missing data, a sample of the dataset showing the data types as well as exploratory visualizations for quantitative and qualitative data.This package is also useful for business users who have to interact with data and want to begin exploring the data without using too much code or having to open a potentially large dataset on Excel. 
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: true
Suggests: 
    testthat (>= 2.1.0),
    covr,
    knitr,
    rmarkdown
RoxygenNote: 7.0.2
Imports: 
    magrittr,
    tools,
    readxl,
    reshape2,
    readr,
    ggplot2,
    tm,
    wordcloud,
    dplyr
URL: https://github.com/UBC-MDS/RDataPeek
BugReports: https://github.com/UBC-MDS/RDataPeek/issues
VignetteBuilder: knitr

Scope

• Please indicate which category or categories from our package fit policies this package falls under: (Please check an appropriate box below. If you are unsure, we suggest you make a pre-submission inquiry.):

  • [ ] data retrieval
    • [x] data extraction
    • [ ] data munging
    • [ ] data deposition
    • [ ] workflow automataion
    • [ ] version control
    • [ ] citation management and bibliometrics
    • [ ] scientific software wrappers
    • [ ] database software bindings
    • [ ] geospatial data
    • [x] text analysis

• Explain how and why the package falls under these categories (briefly, 1-2 sentences): The package extracts information from the data such as the missing values, column type, sample responses, unique value of each column and counts distribution of quantitative column through histograms. It generates a word bubble of qualitative responses (text).

• Who is the target audience and what are scientific applications of this package? The package targets on people such as business userswho have to interact with data and want to begin exploring the data without using too much code or having to open a potentially large dataset on Excel.

• Are there other R packages that accomplish the same thing? If so, how does yours differ or meet our criteria for best-in-category? Several R packages and functions are available that support exploratory data analysis (e.g. Base R's summary(), R ggplot2 and R Word Cloud) but none are specific to the targeted use cases here - a simple and technologically friendly way of summarizing data.

1. Base R’s summary(): This function computes summary statistics for R dataframes. Our package differs in that it aims to offer summary statistics dependent on data type, including long form text data.
2. R ggplot2: Our package will leverage ggplot2 to create visualizations that summarize the dataset as well as user-defined features in the dataset. There are existing recommended visualizations for exploratory data analysis such as missing data visualizations which will be adapted where appropriate.
3. R Word Cloud: This package will also be used to create summary visualizations for long form text data. - 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

Confirm each of the following by checking the box.

• [x] I have read the guide for authors and rOpenSci packaging guide.

This package:

• [x] does not violate the Terms of Service of any service it interacts with. has a CRAN and OSI accepted 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, including reporting of test coverage using services such as Travis CI, Coveralls and/or CodeCov.

Publication options

• [ ] Do you intend for this package to go on CRAN?
• [ ] Do you intend for this package to go on Bioconductor?
• [ ] Do you wish to automatically submit to the Journal of Open Source Software? If so:

JOSS Options

- [ ] The package has an **obvious research application** according to [JOSS's definition](https://joss.readthedocs.io/en/latest/submitting.html#submission-requirements). - [ ] The package contains a `paper.md` matching [JOSS's requirements](https://joss.readthedocs.io/en/latest/submitting.html#what-should-my-paper-contain) with a high-level description in the package root or in `inst/`. - [ ] The package is deposited in a long-term repository with the DOI: - (*Do not submit your package separately to JOSS*)

• [ ] Do you wish to submit an Applications Article about your package to Methods in Ecology and Evolution? If so:

MEE Options

- [ ] The package is novel and will be of interest to the broad readership of the journal. - [ ] The manuscript describing the package is no longer than 3000 words. - [ ] You intend to archive the code for the package in a long-term repository which meets the requirements of the journal (see [MEE's Policy on Publishing Code](http://besjournals.onlinelibrary.wiley.com/hub/journal/10.1111/(ISSN)2041-210X/journal-resources/policy-on-publishing-code.html)) - (*Scope: Do consider MEE's [Aims and Scope](http://besjournals.onlinelibrary.wiley.com/hub/journal/10.1111/(ISSN)2041-210X/aims-and-scope/read-full-aims-and-scope.html) for your manuscript. We make no guarantee that your manuscript will be within MEE scope.*) - (*Although not required, we strongly recommend having a full manuscript prepared when you submit here.*) - (*Please do not submit your package separately to Methods in Ecology and Evolution*)

Code of conduct

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

[moniquewong]

Technical checks

Confirm each of the following by checking the box. This package:

• [ ] does not violate the Terms of Service of any service it interacts with. has a CRAN and OSI accepted license.
• [ ] contains a README with instructions for installing the development version.
• [ ] includes documentation with examples for all functions.
• [ ] contains a vignette with examples of its essential functions and uses.
• [ ] has a test suite.
• [ ] has continuous integration, including reporting of test coverage using services such as Travis CI, Coveralls and/or CodeCov.

Publication options

• [ ] Do you intend for this package to go on CRAN?
• [ ] Do you wish to automatically submit to the Journal of Open Source Software? If so:
  JOSS Options

  
  

• [ ] The package has an obvious research application according to JOSS's definition.

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

  • (Do not submit your package separately to JOSS)

• [ ] Do you wish to submit an Applications Article about your package to Methods in Ecology and Evolution? If so:

MEE Options The package is novel and will be of interest to the broad readership of the journal. The manuscript describing the package is no longer than 3000 words. You intend to archive the code for the package in a long-term repository which meets the requirements of the journal (see MEE's Policy on Publishing Code) (Scope: Do consider MEE's Aims and Scope for your manuscript. We make no guarantee that your manuscript will be within MEE scope.) (Although not required, we strongly recommend having a full manuscript prepared when you submit here.) (Please do not submit your package separately to Methods in Ecology and Evolution)

[ribner]

I was assigned to both the R and Python package for review. After reading the peer review instructions it looks like each student should be assigned one. I'll assume I was expected to decide one of the two packages for review. I went ahead and did the Python project instead of R. Just wanted to make a note here so there was no confusion in the grading. Cheers.