diff --git a/src/models/model_DatasetSimple.jl b/src/models/model_DatasetSimple.jl index 1608f72..10a1478 100644 --- a/src/models/model_DatasetSimple.jl +++ b/src/models/model_DatasetSimple.jl @@ -17,9 +17,9 @@ group, and sequence. # Arguments - `name::String`- **(Optional)** The dataset identifier -- `description::String`-(Optional) A short description of the dataset -- `group::String`-(Optional) The group of datasets to which this dataset belongs. -- `sequence::Int64`-(Optional) The order in which the dataset will appear in the metadata API and extracts. +- `description::String`- **(Optional)** A short description of the dataset +- `group::String`- **(Optional)** The group of datasets to which this dataset belongs. +- `sequence::Int64`- **(Optional)** The order in which the dataset will appear in the metadata API and extracts. # Returns diff --git a/src/models/model_Shapefile.jl b/src/models/model_Shapefile.jl index 9e861c2..0cd019c 100644 --- a/src/models/model_Shapefile.jl +++ b/src/models/model_Shapefile.jl @@ -13,25 +13,34 @@ Shapefile(; sequence=nothing, ) ``` -This function creates a representation for geographic information systems (GIS) files. +This function creates a reference to an NHGIS shapefile for an IPUMS dataset. -# Attributes +# Arguments -- `name::String`-The unique identifier of the shapefile. -- `year::String`-The survey year in which the file's represented areas were used for tabulations. -- `geographicLevel::String`-The geographic level of the shapefile. -- `extent::String`-The geographic extent which is covered by the shapefile. -- `basis::String`-The derivation source of the shapefile. -- `sequence::Int64`- The order the shapefile in which appears in the metadata API. +- `name::String`- **(Optional)** The unique identifier of the shapefile. +- `year::String`- **(Optional)** The survey year in which the file's represented areas were used for tabulations. +- `geographicLevel::String`- **(Optional)** The geographic level of the shapefile. +- `extent::String`- **(Optional)** The geographic extent which is covered by the shapefile. +- `basis::String`- **(Optional)** The derivation source of the shapefile. +- `sequence::Int64`- **(Optional)** The order the shapefile in which appears in the metadata API. # Returns -It returns a list of all the available shapefile. +This function returns a Shapefile object containing the attributes specified in +the function arguments. # Examples ```julia-repl -julia> IPUMS.Shapefile(name = "base.tl2000.nongen.us_state_1790", year = "1790", geographicLevel = "state", extent = "united states", basis = "2000 tiger/line +", sequence = 1) +julia> IPUMS.Shapefile(name = "base.tl2000.nongen.us_state_1790", + year = "1790", + geographicLevel = "state", + extent = "united states", + basis = "2000 tiger/line +", + sequence = 1) + +# Output + { "name": "base.tl2000.nongen.us_state_1790", "year": "1790", @@ -43,8 +52,7 @@ julia> IPUMS.Shapefile(name = "base.tl2000.nongen.us_state_1790", year = "1790", ``` # References -To find out more about the Shapefile type visit : -* https://developer.ipums.org/docs/v2/workflows/explore_metadata/nhgis/shapefiles/ +Additional information about this object is available in the [IPUMS Developer Docs](https://developer.ipums.org/docs/v2/workflows/explore_metadata/nhgis/shapefiles/) """ Base.@kwdef mutable struct Shapefile <: OpenAPI.APIModel name::Union{Nothing, String} = nothing diff --git a/src/models/model_TimeSeriesTableFull.jl b/src/models/model_TimeSeriesTableFull.jl index 6f264d3..06994de 100644 --- a/src/models/model_TimeSeriesTableFull.jl +++ b/src/models/model_TimeSeriesTableFull.jl @@ -13,31 +13,42 @@ TimeSeriesTableFull(; geogLevels=nothing, ) ``` -This function creates a table record for the `TimeSeriesTableFull`. + +This function returns an object containing the attributes for downloading a +Time Series Table. # Arguments -- `name::String`- The unique variable identifier for the time series table, (eg. "A00", "OWNERSHP"). -- `description::String`- A short description of the time series variable referred to in `name`. -- `geographicIntegration::String`- How does the variable value account for changes in geographic boundaries over time, (eg. "Nominal"). -- `sequence::Float32`- The order of appearence of the dataset in the metadata API and extract. -- `timeSeries::Vector{TimeSeriesTableFullTimeSeriesInner}`- A list of time series records corresponding to the variable specified in `name`. -- `geogLevels::Vector{TimeSeriesTableFullTimeSeriesInner}`- A list of geographic levels available for this time series table. +- `name::String`- **(Optional)** The unique variable identifier for the time series table, (eg. "A00", "OWNERSHP"). +- `description::String`- **(Optional)** A short description of the time series variable referred to in `name`. +- `geographicIntegration::String`- **(Optional)** Specifies how the variable accounts for changes in geographic boundaries over time, (eg. "Nominal"). +- `sequence::Float32`- **(Optional)** The order of appearence of the dataset in the metadata API and extract. +- `timeSeries::Vector{TimeSeriesTableFullTimeSeriesInner}`- **(Optional)** A list of time series records corresponding to the variable specified in `name`. +- `geogLevels::Vector{TimeSeriesTableFullTimeSeriesInner}`- **(Optional)** A list of geographic levels available for this time series table. # Returns -The return is a new record for the `TimeSeriesTableFull` containing the variable name, description, time series, and geographical information of the data. +This function return a `TimeSeriesTableFull` object containing the variable +name, description, time series, and geographical information of the data. # Examples ```julia-repl -julia> IPUMS.TimeSeriesTableFull(name="A00", description= "Total Population", + +julia> IPUMS.TimeSeriesTableFull(name="A00", + description= "Total Population", geographicIntegration= "Nominal", sequence= 0.01, - timeSeries=[Dict("name" => "AA", "description" => "Persons: Total", "sequence" => 1 )], - geogLevels= [ Dict( "name" => "state", "description" => "State", "sequence" => 4 ), - Dict( "name" => "county", "description" => "State--County", "sequence" => 25 ) ]) - + timeSeries=[IPUMS.TimeSeriesTableFullTimeSeriesInner(name = "AA", + description = "Persons: Total", + sequence = 1 )], + geogLevels= [ IPUMS.TimeSeriesTableFullTimeSeriesInner(name = "state", + description = "State", + sequence = 4 ), + IPUMS.TimeSeriesTableFullTimeSeriesInner(name = "county", + description = "State--County", + sequence = 25 )]) +# Output { "name": "A00", "description": "Total Population", @@ -46,23 +57,25 @@ julia> IPUMS.TimeSeriesTableFull(name="A00", description= "Total Population", "timeSeries": [ { "name": "AA", - "sequence": 1, - "description": "Persons: Total" + "description": "Persons: Total", + "sequence": 1 } ], "geogLevels": [ { "name": "state", - "sequence": 4, - "description": "State" + "description": "State", + "sequence": 4 }, { "name": "county", - "sequence": 25, - "description": "State--County" + "description": "State--County", + "sequence": 25 } ] } + + ``` # References diff --git a/src/models/model_TimeSeriesTableFullTimeSeriesInner.jl b/src/models/model_TimeSeriesTableFullTimeSeriesInner.jl index e0c1465..ebb300c 100644 --- a/src/models/model_TimeSeriesTableFullTimeSeriesInner.jl +++ b/src/models/model_TimeSeriesTableFullTimeSeriesInner.jl @@ -10,23 +10,29 @@ TimeSeriesTableFullTimeSeriesInner(; sequence=nothing, ) ``` - -Inner constructor representing the variables within a TimeSeriesTableFull object + +This function creates a reference to an IPUMS Time Series table. # Arguments -- `name::String`- The unique identifier of the time series table. -- `description::String`- A short description of the time series table. -- `sequence::Int64`- The order in which the time series table will appear in the metadata API and extracts. +- `name::String`- **(Optional)** The unique identifier of the time series table. +- `description::String`- **(Optional)** A short description of the time series table. +- `sequence::Int64`- **(Optional)** The order in which the time series table will appear in the metadata API and extracts. # Returns -This returns an inner constructor. +This function returns a `TimeSeriesTableFullTimeSeriesInner` object that contains +information about a desired Time Series table. # Examples ```julia-repl -julia> IPUMS.TimeSeriesTableFullTimeSeriesInner(name = "1790_cPop", description = "1790 Census: Population Data [US, States & Counties]", sequence = 101) +julia> IPUMS.TimeSeriesTableFullTimeSeriesInner(name = "1790_cPop", + description = "1790 Census: Population Data [US, States & Counties]", + sequence = 101) + +# Output + { "name": "1790_cPop", "description": "1790 Census: Population Data [US, States & Counties]", @@ -35,8 +41,8 @@ julia> IPUMS.TimeSeriesTableFullTimeSeriesInner(name = "1790_cPop", description ``` # References -To find out more about the TimeSeriesTableFullTimeSeriesInner visit: -* https://developer.ipums.org/docs/v2/workflows/explore_metadata/nhgis/time_series/ + +Additional information about the `TimeSeriesTableFullTimeSeriesInner`object is available in the [IPUMS Developer Docs](https://developer.ipums.org/docs/v2/workflows/explore_metadata/nhgis/time_series/) """ Base.@kwdef mutable struct TimeSeriesTableFullTimeSeriesInner <: OpenAPI.APIModel name::Union{Nothing, String} = nothing