Skip to content

Submission Inquiry: nycOpenData #750

@martinezc1

Description

@martinezc1

Submitting Author Name: Christian Martinez
Submitting Author Github Handle: @martinezc1
Repository: https://github.com/martinezc1/nycOpenData
Version submitted: 0.1.6
Submission type: Standard
Editor: @ronnyhdez
Reviewers: TBD

Archive: TBD
Version accepted: TBD
Language: en


  • Paste the full DESCRIPTION file inside a code block below:
Package: nycOpenData
Type: Package
Title: Convenient Access to NYC Open Data API Endpoints
Version: 0.1.6
Authors@R: 
    c(
      person("Christian", "Martinez", 
             email = "c.martinez0@outlook.com", 
             role = c("aut", "cre"),
             comment = c(
               GitHub = "martinezc1",
               ORCID = "0009-0005-6026-6454"
             )),
      person("Crystal", "Adote",
             role = "ctb",
             comment = c(GitHub = "crystalna20")),
      person("Jonah", "Dratfield", 
             role = "ctb",
             comment = c(GitHub = "jdratfield38")),
      person("Joyce", "Escatel-Flores",
             role = "ctb",
             comment = c(GitHub = "JoyceEscatel")),
      person("Rob", "Hutto", 
             role = "ctb",
             comment = c(GitHub = "robhutto")),
      person("Isley", "Jean-Pierre",
             role = "ctb",
             comment = c(GitHub = "ijpier")),
      person("Shannon", "Joyce",
             role = "ctb",
             comment = c(GitHub = "shannonjoyce")),
      person("Laura", "Rose-Werner",
             role = "ctb",
             comment = c(GitHub = "laurarosewerner")),
      person("Emma", "Tupone",
             role = "ctb",
             comment = c(GitHub = "emmatup0205")),
      person("Xinru", "Wang",
             role = "ctb",
             comment = c(GitHub = "xrwangxr"))
    )
Description: Provides a unified set of helper functions to access datasets 
    from the NYC Open Data platform <https://opendata.cityofnewyork.us/>. 
    Functions return results as tidy tibbles and support optional filtering, 
    sorting, and row limits via the Socrata API. The package includes endpoints 
    for 311 service requests, DOB job applications, juvenile justice metrics, 
    school safety, environmental data, event permitting, and additional citywide datasets.
License: MIT + file LICENSE
Encoding: UTF-8
RoxygenNote: 7.3.3
Imports: 
    httr,
    jsonlite,
    tibble,
    curl
Suggests: 
    dplyr,
    ggplot2,
    knitr,
    rmarkdown,
    scales,
    testthat (>= 3.0.0),
    tidyr,
    vcr (>= 0.6.0),
    webmockr
URL: https://martinezc1.github.io/nycOpenData/, https://github.com/martinezc1/nycOpenData
BugReports: https://github.com/martinezc1/nycOpenData/issues
VignetteBuilder: knitr
Config/testthat/edition: 3


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
    • data validation and testing
    • workflow automation
    • version control
    • citation management and bibliometrics
    • scientific software wrappers
    • field and lab reproducibility tools
    • database software bindings
    • geospatial data
    • translation
  • Explain how and why the package falls under these categories (briefly, 1-2 sentences):

The package provides a programmatic interface to the Socrata-backed NYC Open Data API, replacing manual CSV downloads with reproducible R code.

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

Target Audience: The primary audience includes urban researchers, social scientists, and students in the CUNY system and beyond. It is specifically designed for analysts who need to integrate civic data into reproducible workflows without the overhead of manual data management.

Scientific Applications: nycOpenData facilitates large-scale urban studies, including spatial analysis of public service equity (via 311 data), longitudinal studies of urban ecology (via the Tree Census), and sociological research into school safety and juvenile justice trends. By providing a programmatic interface, it ensures that these urban analyses are fully reproducible and auditable.

The most closely related package is RSocrata, which provides a general-purpose interface for any Socrata-backed data portal. nycOpenData differs by meeting the "best-in-category" criteria through domain specialization.

Yes. The package exclusively accesses publicly available NYC Open Data datasets. It does not collect, infer, or augment personal data beyond what is provided by the data publisher, and it encourages responsible use of potentially sensitive fields (e.g., location data) in accordance with dataset-specific guidance and NYC Open Data terms.

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

#748
@emilyriederer
@ronnyhdez

  • Explain reasons for any pkgcheck items which your package is unable to pass.

None. All pkgcheck checks pass locally and in continuous integration.

Technical checks

Confirm each of the following by checking the box.

This package:

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)
  • (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)

Code of conduct

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions