Initiate a package review request

[kmoravej]

Each team must initiate a review request by opening an issue per package in the UBC-MDS/software-review-2021 repository.

• For initiating a reviewing request in R, use this template.

• For initiating a reviewing request in Python, use the template under Submit Software for Review at this link.

[kmoravej]

Submitting Author:

• Sukhdeep Kaur (@sukh2929 )
• Rafael Pilliard-Hellwig (@rtaph)
• Kamal Moravej (@kmoravej)

Repository: https://github.com/UBC-MDS/labzenr Version submitted: Editor: TBD Reviewers: TBD

Archive: TBD Version accepted: TBD

Package: labzenr
Title: A package to help UBC MDS students manage their labs
Version: 0.0.0.9000
Authors@R: 
    c(person(given = "Kamal",
           family = "Moravej",
           role = c("aut", "cre"),
           email = "sk.moravej@gmail.com"),
      person(given = "Rafael",
           family = "Pilliard-Hellwig",
           email = "rtaph@student.ubc.ca",
           role = c("aut")),
      person(given = "Sukhdeep",
             family = "Kaur",
             email = "Sukhdeep_2929@yahoo.com",
             role = c("aut")))
Description: labzenr is a R package that adds  more zen to your student experience of working on MDS labs.  
It lets you manage common tasks such as counting total marks in an assignment, and performs common 
checks for mechanics in your IPython notebooks and R markdown assignments.
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.1.1
URL: https://github.com/UBC-MDS/labzenr
BugReports: https://github.com/UBC-MDS/labzenr/issues
Suggests: 
    covr,
    checkmate,
    credentials,
    knitr,
    mockery,
    rmarkdown,
    testthat (>= 3.0.0)
Config/testthat/edition: 3
Imports: 
    fs,
    stringi,
    usethis,
    gert,
    magrittr,
    janitor,
    dplyr,
    tibble,
    tidyr,
    jsonlite,
    stringr,
    rlang,
    purrr,
    glue,
    withr
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
  • [ ] data extraction
  • [ ] data munging
  • [ ] data deposition
  • [X] workflow automation
  • [X] version control
  • [ ] citation management and bibliometrics
  • [ ] scientific software wrappers
  • [ ] field and lab reproducibility tools
  • [ ] database software bindings
  • [ ] geospatial data
  • [ ] text analysis

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

  • The package is classified as workflow automation because it uses automate to help MDS student managing MDS labs.
  • It is classified as version control because part of checks include verification on a git log.

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

  • The target audience is MDS students and potentially MDS instructors.

• Are there other R packages that accomplish the same thing? If so, how does yours differ or meet our criteria for best-in-category?

• To the authors' knowledge, no package yet exists in the R ecosystem that serves this specific purpose. However, several existing packages will be used to power the functionality of labzenr, including gert and usethis.Some other python repos and past assignments may be used as inspiration, such as the parsing work done in the throughput database in DSCI 513.

• (If applicable) Does your package comply with our guidance around Ethics, Data Privacy and Human Subjects Research?

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

• [ ] does not violate the Terms of Service of any service it interacts with.
• [ X] 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, created with roxygen2.
• [ ] 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 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.