Skip to content

Commit

Permalink
make this a minor, not patch, release
Browse files Browse the repository at this point in the history
  • Loading branch information
cole-brokamp committed Mar 10, 2022
1 parent 110d681 commit 19be62b
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ FROM rocker/r-ver:4.1.2

# DeGAUSS container metadata
ENV degauss_name="geocoder"
ENV degauss_version="3.1.1"
ENV degauss_version="3.2.0"
ENV degauss_description="geocodes"
ENV degauss_argument="valid_geocode_score_threshold [default: 0.5]"

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@
If `my_address_file.csv` is a file in the current working directory with an address column named `address`, then the [DeGAUSS command](https://degauss.org/using_degauss.html#DeGAUSS_Commands):

```sh
docker run --rm -v $PWD:/tmp ghcr.io/degauss-org/geocoder:3.1.1 my_address_file.csv
docker run --rm -v $PWD:/tmp ghcr.io/degauss-org/geocoder:3.2.0 my_address_file.csv
```

will produce `my_address_file_geocoder_3.1.1_score_threshold_0.5.csv` with added columns:
will produce `my_address_file_geocoder_3.2.0_score_threshold_0.5.csv` with added columns:

- **`matched_street`**, **`matched_city`**, **`matched_state`**, **`matched_zip`**: matched address componets (e.g., `matched_street` is the street the geocoder matched with the input address); can be used to investigate input address misspellings, typos, etc.
- **`precision`**: The method/precision of the geocode. The value will be one of:
Expand All @@ -33,7 +33,7 @@ will produce `my_address_file_geocoder_3.1.1_score_threshold_0.5.csv` with added

- Geocodes with a resulting precision of `intersection`, `zip`, or `city` are returned with a missing `lat` and `lon` because they are likely too inaccurate and/or too imprecise to be used for further analysis.
- By default, `lat` and `lon` are also returned as missing if the `score` is less than `0.5` (regardless of the precision).
- This threshold can be changed by including an optional argument in the docker call (e.g., `docker run --rm -v $PWD:/tmp degauss/geocoder:3.1.1 my_address_file.csv 0.6`).
- This threshold can be changed by including an optional argument in the docker call (e.g., `docker run --rm -v $PWD:/tmp degauss/geocoder:3.2.0 my_address_file.csv 0.6`).

## Geomarker Methods

Expand Down

0 comments on commit 19be62b

Please sign in to comment.