Zoning Changes

NYCPlanning · Nov 25, 2024 · aa985f7 · aa985f7
1 parent 4363738
commit aa985f7
Show file tree

Hide file tree

Showing 6 changed files with 128 additions and 17 deletions.
diff --git a/data_dictionary.yml b/data_dictionary.yml
@@ -6,36 +6,81 @@ product: {}
 
 dataset:
   fields:
+    # Dataset Information
+    display_name:
+      summary: "Dataset Name"
+      extra_description: ""
+    agency:
+      summary: "Data Provided by"
+      extra_description: The name of the NYC agency providing this data to the public.
+    each_row_is_a:
+      summary: "Each row is a..."
+      extra_description: The unit of analysis/level of aggregation of the dataset
+    publishing_frequency:
+      summary: "Publishing Frequency"
+      extra_description: |
+        How often changed data is published to this dataset. For an automatically updated dataset, this is the frequency of that automation
+    publishing_frequency_details:
+      summary: "Frequency Details"
+      extra_description: Additional details about the publishing or data change frequency, if needed
+    data_change_frequency:
+      summary: Data Change Frequency
+      extra_description: How often the data underlying this dataset is changed
+    description:
+      summary: Dataset Description
+      extra_description: |
+        Overview of the information this dataset contains, including overall context and definitions of key terms. This field may include links to supporting datasets, agency websites, or external resources for additional context.
+    publishing_purpose:
+      summary: Why is this data collected?
+      extra_description: |
+        Purpose behind the collection of this data, including any legal or policy requirements for this data by NYC Executive Order, Local Law, or other policy directive.
+    data_collection_method:
+      summary: How is this data collected?
+      extra_description: |
+        The methods used to create and update this dataset, including what cleaning or processing was involved prior to dataset publication.
+
+        If data collection includes interpreting physical information this field includes technical details.
+
+        If data collection includes fielding applications, requests, or complaints, this field includes details about the forms, applications, and processes used.
+    potential_uses:
+      summary: How can this data be used?
+      extra_description: |
+        Examples of and/or links to projects or agency operations that have used this dataset.
+      custom:
+        oti_extra_notes: |
+          Where relevant, includes links to online projects, agency websites, visualizations, maps, or dashboards.
+
+          What are some questions one might answer using this dataset?
+    disclaimer:
+      summary: What are the unique characteristics or limitations of this dataset?
+      extra_description: |
+        Unique characteristics of this dataset to be aware of, specifically, constraints or limitations to the use of the data.
+    projection:
+      summary: Additional geospatial information
+      extra_description: |
+        For any datasets with geospatial data, specify the coordinate reference system or projection used and other relevant details.
+
     # Primer / Internal Page
     tags:
       summary: Dataset Tags
       extra_description: |
-        A list of comma-separated terms, based on the topic of the dataset,
-        that will link to other datasets with that same tag.
+        A list of comma-separated terms, based on the topic of the dataset, that will link to other datasets with that same tag.
       custom:
         oti_extra_notes: Tags are used along with the dataset name and description to search NYC Open Data.
     rows_removed:
       summary: Are rows removed from this dataset when the data is updated?
       extra_description: |
-        related to another Local Law (106 of 2015) for data retention.
-        Basically, if the dataset is updated as append or upsert, the answer is Yes.
+        Related to another Local Law (106 of 2015) for data retention. Basically, if the dataset is updated as append or upsert, the answer is Yes.
     can_be_automated:
       summary: Can this dataset be feasibly automated?
       extra_description: ""
-    on_agency_website:
+    attribution_link:
       summary: Is this data also present on a website maintained by or on behalf of the agency?
       extra_description: ""
       custom:
         oti_extra_notes: If so, please provide the website URL.
-    publishing_frequency:
-      summary: What is the update frequency of the data on the agency's website?
-      extra_description: ""
-      custom:
-        oti_extra_notes: Only applicable if the data is also present on a website maintained by or on behalf of the agency
     agency_website_data_updated_automatically:
       summary: Is the data on the agency's website updated automatically?
       extra_description: ""
       custom:
         oti_extra_notes: Only applicable if the data is also present on a website maintained by or on behalf of the agency
-
-    # Dataset Information
diff --git a/metadata.yml b/metadata.yml
@@ -2,11 +2,23 @@ attributes:
   agency: "Department of City Planning (DCP)"
   category: "City Government"
   attribution: "Department of City Planning (DCP)"
-  attributionLink: "https://www.nyc.gov/site/planning/data-maps/open-data.page"
+  attribution_link: "https://www.nyc.gov/site/planning/data-maps/open-data.page"
   rows_removed: True
   can_be_automated: True
   on_agency_website: True
-  agency_website_data_updated_automatically: True
+  agency_website_data_updated_automatically: False
+  projection: NAD 1983 StatePlane New York Long Isl FIPS 3104 (US Feet)
+  publishing_purpose: >
+    The Department of City Planning (DCP) is New York City’s primary land use agency. DCP is responsible for
+    maintaining the Zoning Resolution text and maps that provide the policy and regulatory basis for land use
+    and development, as mandated by the State and local laws.
+  disclaimer: >
+    This dataset is being provided by the Department of City Planning (DCP) on DCP’s  website for
+    informational purposes only. DCP does not warranty the completeness,  accuracy, content, or fitness for
+    any particular purpose or use of the dataset,  nor are any such warranties to be implied or inferred with
+    respect to the dataset  as furnished on the website. DCP and the City are not liable for any
+    deficiencies in the completeness, accuracy, content, or fitness for any particular purpose or
+    use the dataset, or applications utilizing the dataset, provided by any third party.
 
 products:
 - building_elevation_and_subgrade

diff --git a/packaging/artifacts.yml b/packaging/artifacts.yml
@@ -0,0 +1,52 @@
+artifacts:
+  - name: oti_xlsx
+    type: xlsx
+    tabs:
+      - id: dataset_information
+        name: Dataset Information
+        index: 0
+        title: Data Dictionary
+        subtitle: Dataset Information
+        image_path: Open_Data_Logo.png
+        data_source: dataset.attributes # TODO: actually implement this
+        fields:
+          - display_name
+          - agency
+          - each_row_is_a
+          - publishing_frequency
+          - data_change_frequency
+          - publishing_frequency_details
+          - description
+          - publishing_purpose
+          - data_collection_method
+          - potential_uses
+          - disclaimer
+          - projection
+      - id: revision_history
+        name: Dataset Revision History
+        index: 2
+        title: Data Dictionary
+        subtitle: Dataset Information
+        data_source: dataset.revisions
+        description: >
+          Description of all major changes to the format including what specific fields were added or removed,
+          data calculation method, or method of collection of the data that have taken place since the initial
+          version. Adding or updating new data values does not necessitate a new version entry.
+        fields: []
+      - id: internal_primer
+        name: Primer Page & Internal Information
+        index: 3
+        title: Data Dictionary
+        subtitle: Open Data Team Internal Information
+        description: |
+          This section is used for internal purposes only by the Open Data Team and can be ignored by external data users.
+
+          Information shared in this section may be publicly displayed on the dataset’s primer page on NYC Open Data.
+        data_source: dataset.attributes
+        fields:
+          - tags
+          - rows_removed
+          - can_be_automated
+          - attribution_link
+          - publishing_frequency
+          - agency_website_data_updated_automatically
diff --git a/packaging/resources/Open_Data_Logo.png b/packaging/resources/Open_Data_Logo.png
diff --git a/products/zoning/commercial_overlay_district/metadata.yml b/products/zoning/commercial_overlay_district/metadata.yml
@@ -2,11 +2,11 @@ id: commercial_overlay_district
 
 attributes:
   description: |-
-    Commercial overlay districts for New York City. A commercial overlay is a C1 or C2 district mapped within residential zoning districts to serve local retail needs. Data is updated monthly.
+    Commercial overlay districts for New York City. A commercial overlay is a C1 or C2 district mapped within residential zoning districts to serve local retail needs.
 
     Polygon features representing the within-tax-block limits for commercial overlay districts, as shown on the DCP zoning maps. Commercial overlay district designations are indicated in the OVERLAY attribute.
-  display_name: Zoning - Commercial Overlay (NYCO)
-  each_row_is_a: Commercial Overlay District
+  display_name: Commercial Overlay (NYCO)
+  each_row_is_a: Commercial Overlay district
   publishing_frequency: Monthly
   tags:
     - dcp

diff --git a/products/zoning/metadata.yml b/products/zoning/metadata.yml
@@ -2,6 +2,8 @@ id: zoning
 
 dataset_defaults:
   publishing_frequency: Monthly
+  data_change_frequency: Monthly
+  attribution_link: "https://www.nyc.gov/site/planning/data-maps/open-data/dwn-gis-zoning.page"
 
 datasets:
 - commercial_overlay_district