diff --git a/.zenodo.json b/.zenodo.json index a68d4c45..f4bc16ad 100644 --- a/.zenodo.json +++ b/.zenodo.json @@ -4,35 +4,25 @@ "title": "useeior", "upload_type": "software", "creators": [ - { - "affiliation": "General Dynamics Information Technology, Inc.", - "name": "Mo Li" - "orcid": "https://orcid.org/0000-0002-3672-1622" - }, - { - "affiliation": "US Environmental Protection Agency", - "name": "Wesley Ingwersen" - "orcid": "https://orcid.org/0000-0002-9614-701X" - }, { "affiliation": "Eastern Research Group", - "name": "Ben Young" + "name": "Ben Young", "orcid": "https://orcid.org/0000-0001-6276-8670" }, { "affiliation": "Eastern Research Group", - "name": "Jorge Vendries" + "name": "Jorge Vendries", "orcid": "https://orcid.org/0000-0002-8452-229X" - }, - { - "affiliation": "US Environmental Protection Agency", - "name": "Catherine Birney", - "orcid": "https://orcid.org/0000-0003-4467-9927" + }, + { + "affiliation": "General Dynamics Information Technology, Inc.", + "name": "Mo Li", + "orcid": "https://orcid.org/0000-0002-3672-1622" }, { - "affiliation": "Eastern Research Group", - "name": "Andrew Beck", - "orcid": "https://orcid.org/0000-0003-4051-6901" + "affiliation": "US Environmental Protection Agency", + "name": "Wesley Ingwersen", + "orcid": "https://orcid.org/0000-0002-9614-701X" } ], "access_right": "open" diff --git a/DESCRIPTION b/DESCRIPTION index 1f02366e..183fb7cb 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,12 +2,12 @@ Package: useeior Type: Package Title: USEEIO R modeling software Version: 1.4.0 -Date: 2023-8-24 +Date: 2024-1-19 Authors@R: c( - person("Mo","Li", email="mo.li@gdit.com", role="aut"), - person("Wesley","Ingwersen", email="ingwersen.wesley@epa.gov", role= c("aut", "cre")), person("Ben","Young", email="ben.young@erg.com", role="aut"), - person("Jorge","Vendries", email="jvendries@gmail.com", role="aut")) + person("Jorge","Vendries", email="jvendries@gmail.com", role="aut"), + person("Mo","Li", email="mo.li@gdit.com", role="aut"), + person("Wesley","Ingwersen", email="ingwersen.wesley@epa.gov", role= c("aut", "cre"))) Description: The United States Environmentally-Extended Input-Output model is a model used to estimate potential environmental and economic impacts associated with the production and consumption of goods and services in the US. diff --git a/README.md b/README.md index c7f0d35a..4b36353e 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ `useeior` is an R package for building and using [USEEIO models](https://www.epa.gov/land-research/us-environmentally-extended-input-output-useeio-models). -The [model object](format_specs/Model.md) is the primary output that is built according to a given [model specification](format_specs/ModelSpecification.md) and optional hybridization specification, e.g. [disaggregation](format_specs/DisaggregationAndAggregationSpecification.md). +The [model object](format_specs/Model.md) is the primary output that is built according to a given [model specification](format_specs/ModelSpecification.md) and optional hybridization specification, e.g. [disaggregation](format_specs/ModelCustomization.md). [Model specifications](inst/extdata/modelspecs) and associated hybridization specifications, e.g. [disaggregation](inst/extdata/disaggspecs), for EPA-validated models are included in the package. `useeior` offers various functions for validating, calculating, visualizing, and writing out models and/or their components. diff --git a/format_specs/ModelSpecification.md b/format_specs/ModelSpecification.md index 51cbfe60..a9326897 100644 --- a/format_specs/ModelSpecification.md +++ b/format_specs/ModelSpecification.md @@ -7,11 +7,11 @@ Model specifications are assigned in a yml file based on the parameters shown be | BaseIOSchema | int | Y | The base IO schema (e.g. 2012) | | BaseIOLevel | str | Y | The base IO level of detail (e.g. `Detail`) | | IOYear | int | Y | The base IO year | -| PrimaryRegionAcronym | str | Y | The primary region acronym | | ModelRegionAcronyms | list | Y | The model region acronyms | | ModelType | str | Y | The [model type](#Model-Types) (e.g. `EEIO`) | -| ModelSource | str | Y | The model source | -| BasePriceType | str | Y | The model base price type (producer or purchaser) | +| IODataSource | str | Y | The model source (e.g. `BEA` or `stateior`) | +| IODataVersion | str | N | Required if IODataSource is `stateior`, [stateior model version number](https://github.com/USEPA/stateior/wiki/Planned-Package-Releases) | +| BasePriceType | str | Y | The model base price type (`PRO`: producer or `PUR`: purchaser) | | BasewithRedefinitions | bool | Y | Whether the model is based with redefinitions (TRUE or FALSE) | | CommodityorIndustryType | str | Y | Define if this is a commodity x commodity (`Commodity`) or industry x industry (`Industry`) model | | ScrapIncluded | bool | Y | Whether the model includes scrap (TRUE or FALSE) |