inst/degauss_README.md

In degauss-org/dht: A Collection of Functions to Assist Building DeGAUSS Containers

{{{name}}}

Using

If my_address_file_geocoded.csv is a file in the current working directory with coordinate columns named lat and lon, then the DeGAUSS command:

docker run --rm -v $PWD:/tmp ghcr.io/degauss-org/{{{name}}}:{{{version}}} my_address_file_geocoded.csv

will produce my_address_file_geocoded_{{{name}}}_{{{version}}}.csv with added columns:

• this_geomarker: a definition of this geomarker
• that_geomarker: a definition of that geomarker

Optional Argument

• If this DeGAUSS container takes an optional argument, describe its usage and effects here.
• Be sure to also update the example output file name with the argument value.

Geomarker Methods

• If needed, put details here about the methods and assumptions used in the geomarker assessment process.

Geomarker Data

• List how geomarker was created, ideally including any scripts within the repo used to do so or linking to an external repository
• If applicable, list where geomarker data is stored in S3 using a hyperlink like: s3://path/to/{{{name}}}.rds

DeGAUSS Details

For detailed documentation on DeGAUSS, including general usage and installation, please see the DeGAUSS homepage.

degauss-org/dht documentation built on Oct. 28, 2023, 1:20 a.m.