Note: This article is a work in progress
EXAMPLES OF FILES & TEST DATA EJAM CAN IMPORT OR OUTPUT
Sample spreadsheets & shapefiles for trying the web app
Examples of .xlsx files and shapefiles are installed locally with EJAM, as input files you can use to try out EJAM functions or the web app, or to see what an input file should look like.
Files and Datasets Installed with EJAM
For just one topic you can see all files and data objects like this:
topic = "fips" # or "shape" or "latlon" or "naics" or "address" etc.
# datasets / R objects
cbind(data.in.package = sort(grep(topic, EJAM:::pkg_data()$Item, value = T)))
#> Get more info with pkg_data(simple = FALSE)
#>
#> ignoring sortbysize because simple=TRUE
#> data.in.package
#> [1,] "testinput_fips_blockgroups"
#> [2,] "testinput_fips_cities"
#> [3,] "testinput_fips_counties"
#> [4,] "testinput_fips_states"
#> [5,] "testinput_fips_tracts"
#> [6,] "testoutput_ejamit_fips_cities"
#> [7,] "testoutput_ejamit_fips_counties"
# files
cbind(files.in.package = sort(basename(testdata(topic, quiet = T))))
#> files.in.package
#> [1,] "cities_2.xlsx"
#> [2,] "counties_in_AL_detailed.xlsx"
#> [3,] "counties_in_Alabama.xlsx"
#> [4,] "counties_in_Delaware_invalid.xlsx"
#> [5,] "counties_in_Delaware.xlsx"
#> [6,] "county_10.xlsx"
#> [7,] "county_100.xlsx"
#> [8,] "county_1000.xlsx"
#> [9,] "county_state_300.xlsx"
#> [10,] "fips"
#> [11,] "state_10.xlsx"
#> [12,] "state_50.xlsx"
#> [13,] "state_county_tract_10.xlsx"
#> [14,] "tract_10.csv"
#> [15,] "tract_100.csv"
#> [16,] "tract_1000.csv"
#> [17,] "tract_state_285.xlsx"Local folders with sample files
The best, simplest way to see all these files is the function called testdata()
You can try uploading these kinds of files in the web app, for example, by finding them in these local folders where you installed the package:
- /
EJAM/testdata/latlon/testpoints_100.xlsx - /
EJAM/testdata/shapes/portland_shp.zip - etc.
To open the locally installed “testdata” folders (in Windows File Explorer, or MacOS Finder)
Example of using a file in EJAM
testpoint_files <- list.files(
system.file("testdata/latlon", package = "EJAM"),
full.names = T
)
testpoint_files
latlon_from_anything(testpoint_files[2]) Sample R data objects: Examples of inputs & outputs of EJAM functions
The package has a number of data objects, installed as part of EJAM and related packages, that are examples of inputs or intermediate data objects that you can use to try out EJAM functions, or you may just want to see what the outputs and inputs look like, or you could use them for testing purposes.
For documentation on each input or output item (R object), see reference documentation on each object
This code snippet provides a useful list of test/ sample data objects in EJAM and related packages:
POINT DATA (LAT/LON COORDINATES) for testing
ejamit(), mapfast(),
ejscreenit(), getblocksnearby(), etc.
See all files and all dataset examples related to one topic:
topic = "fips"
cbind(data.in.package = sort(grep(topic, EJAM:::pkg_data()$Item, value = T)))
cbind(files.in.package = sort(basename(testdata(topic, quiet = T))))
x[grepl("^testp", x$Item), ]
#> Package Item
#> 52 EJAM testpoints_10
#> 130 EJAM testpoints_100
#> 131 EJAM testpoints_100_dt
#> 152 EJAM testpoints_1000
#> 167 EJAM testpoints_10000
#> 119 EJAM testpoints_5
#> 128 EJAM testpoints_50
#> 146 EJAM testpoints_500
#> 120 EJAM testpoints_bad
#> 112 EJAM testpoints_overlap3
#> Title
#> 52 test points data.frame with columns sitenumber, lat, lon
#> 130 test points data.frame with columns sitenumber, lat, lon
#> 131 test points data.frame with columns sitenumber, lat, lon
#> 152 test points data.frame with columns sitenumber, lat, lon
#> 167 test points data.frame with columns sitenumber, lat, lon
#> 119 test points data.frame with columns sitenumber, lat, lon
#> 128 test points data.frame with columns sitenumber, lat, lon
#> 146 test points data.frame with columns sitenumber, lat, lon
#> 120 test points data.frame with columns note, lat, lon
#> 112 test points data.frame with columns note, lat, lonSTREET ADDRESSES for testing geocoding in
latlon_from_address() etc.
x[grepl("^test_", x$Item), ]
#> [1] Package Item Title
#> <0 rows> (or 0-length row.names)
cat("\n\n")FACILITY REGISTRY IDs for testing
latlon_from_regid() etc.
x[grepl("^test[^op_]", x$Item), ]
#> Package Item
#> 50 EJAM testinput_address_2
#> 110 EJAM testinput_address_9
#> 111 EJAM testinput_address_parts
#> 116 EJAM testinput_address_table
#> 129 EJAM testinput_address_table_9
#> 117 EJAM testinput_address_table_goodnames
#> 118 EJAM testinput_address_table_withfull
#> 15 EJAM testinput_fips_blockgroups
#> 1 EJAM testinput_fips_cities
#> 2 EJAM testinput_fips_counties
#> 3 EJAM testinput_fips_states
#> 16 EJAM testinput_fips_tracts
#> 4 EJAM testinput_mact
#> 5 EJAM testinput_naics
#> 6 EJAM testinput_program_name
#> 51 EJAM testinput_program_sys_id
#> 7 EJAM testinput_regid
#> 8 EJAM testinput_registry_id
#> 135 EJAM testinput_shapes_2
#> 9 EJAM testinput_sic
#> 134 EJAM testshapes_2
#> Title
#> 50 datasets for trying address-related functions
#> 110 datasets for trying address-related functions
#> 111 datasets for trying address-related functions
#> 116 datasets for trying address-related functions
#> 129 datasets for trying address-related functions
#> 117 datasets for trying address-related functions
#> 118 datasets for trying address-related functions
#> 15 testinput_fips_blockgroups dataset
#> 1 testinput_fips_cities dataset
#> 2 testinput_fips_counties dataset
#> 3 testinput_fips_states dataset
#> 16 testinput_fips_tracts dataset
#> 4 testinput_mact dataset
#> 5 testinput_naics dataset
#> 6 testinput_program_name dataset
#> 51 test data, EPA program names and program system ID numbers to try using
#> 7 test data, EPA Facility Registry ID numbers to try using
#> 8 test data, EPA Facility Registry ID numbers to try using
#> 135 testinput_shapes_2 dataset
#> 9 testinput_sic dataset
#> 134 testshapes_2 dataset
cat("\n\n")EXAMPLES OF OUTPUTS from ejamit(),
ejscreenit(), getblocksnearby(), etc., you can
use as inputs to ejam2report(), ejam2excel(),
ejam2ratios(), ejam2barplot(),
doaggregate(), etc.
x[grepl("^testout", x$Item), ]
#> Package Item
#> 178 EJAM testoutput_doaggregate_1000pts_1miles
#> 170 EJAM testoutput_doaggregate_100pts_1miles
#> 160 EJAM testoutput_doaggregate_10pts_1miles
#> 179 EJAM testoutput_ejamit_1000pts_1miles
#> 171 EJAM testoutput_ejamit_100pts_1miles
#> 166 EJAM testoutput_ejamit_10pts_1miles
#> 168 EJAM testoutput_ejamit_fips_cities
#> 169 EJAM testoutput_ejamit_fips_counties
#> 159 EJAM testoutput_ejamit_shapes_2
#> 143 EJAM testoutput_ejscreenapi_1pts_1miles
#> 150 EJAM testoutput_ejscreenapi_plus_5
#> 155 EJAM testoutput_ejscreenit_5
#> 162 EJAM testoutput_ejscreenit_50
#> 175 EJAM testoutput_ejscreenit_500
#> 137 EJAM testoutput_ejscreenRESTbroker_1pts_1miles
#> 174 EJAM testoutput_getblocksnearby_1000pts_1miles
#> 158 EJAM testoutput_getblocksnearby_100pts_1miles
#> 149 EJAM testoutput_getblocksnearby_10pts_1miles
#> Title
#> 178 test output of doaggregate()
#> 170 test output of doaggregate()
#> 160 test output of doaggregate()
#> 179 test output of ejamit()
#> 171 test output of ejamit()
#> 166 test output of ejamit()
#> 168 testoutput_ejamit_fips_cities dataset
#> 169 testoutput_ejamit_fips_counties dataset
#> 159 testoutput_ejamit_shapes_2 dataset
#> 143 test data, output from this function
#> 150 test data examples of output from 'ejscreenapi_plus()' using testpoints_5, radius = 1
#> 155 test data examples of output from 'ejscreenit()' using testpoints_5, radius = 1
#> 162 test data examples of output from 'ejscreenit()' using testpoints_50, radius = 1
#> 175 test data examples of output from 'ejscreenit()' using testpoints_500, radius = 1
#> 137 test data, output from this function
#> 174 test output of getblocksnearby(), and is an input to doaggregate()
#> 158 test output of getblocksnearby(), and is an input to doaggregate()
#> 149 test output of getblocksnearby(), and is an input to doaggregate()
cat("\n\n")LARGE DATASETS USED BY THE PACKAGE
Note that the largest files used by the package are mostly the block-related datasets with info about population size and location of US blocks, the facility datasets with info about EPA-regulated sites, and the blockgroup-related datasets with EJScreen indicators.
Some datasets get downloaded by the package at installation or launch or as needed. See the article on Updating EJAM Datasets for more information on these.
Also see reference documentation for each dataset.