CONTRIBUTING.md

In Prof-Rodrigo-Silva/geobage: Shapefiles of Official Spatial Data Sets of Bage

Become a geobage contributor:

If you would like to contribute to geobage, the first thing to do is open an issue on Github with your suggestion of a function or dataset you would like to see in the package. Keep in mind that, as a rule, the package includes only geospatial datasets with national spatial coverage over the municipality of Bagé - RS and that are created/managed by government institutions and are publicly available.

Adding each dataset to the geobage follows a three-step process as follows:

Step 1. Data preparation

In the first step, the contributor should write an R script that will prepare the raw original data set to be used in geobage. This script should (1) download the raw data from the original website source, (2) rename column names following a simple spelling convention*, (3) ensure the data uses spatial projection EPSG 4674, (4) ensure every string column is as.character with UTF-8 encoding, (5) fix eventual topology issues in the data, and (6) save the data in .geojson format. (7) The file name must be in all caps. For more details, see here how to build with geospatial data, the data is stored in its own repository, access here.

This script can use any R package, but it needs to be 100% reproducible.

Step 2. Data validation and upload

Once it's ready, the geobage team will test and validate the data output. If all goes well, the geobage team will upload the data to make it available.

Step 3. Download and test functions

In this step, the developer must write the package function that will be used to download the data. Most download functions have a relatively simple structure and documentation. Please take a look at some of the other geobage functions for a reference. Function names must also follow our simple spelling convention.

Once the download script is ready, the geobr team will write a script to test the function. If all goes well, the collaborator can open a pull request and start the celebration. We will update our documentation to add your name to our team of contributors.

Prof-Rodrigo-Silva/geobage documentation built on July 27, 2022, 2:14 p.m.