changes on model files

Project.toml

@@ -9,7 +9,6 @@ Downloads = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
 EzXML = "8f5d6c58-4d21-5cfd-889c-e3ad7ee6a615"
 HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"
 JSON3 = "0f8b85d8-7281-11e9-16c2-39a750bddbf1"
-LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
 OpenAPI = "d5e62ea6-ddf3-4d43-8e4c-ad5e6c8bfd7d"
 
 [compat]

docs/Project.toml

@@ -2,3 +2,4 @@
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 IPUMS = "51d1f77e-d457-4c14-a89d-9ed71839f38d"
 LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
+Revise = "295af30f-e4ad-537b-8983-00126c2a3abe"

docs/make.jl

@@ -1,5 +1,7 @@
 using IPUMS
 using Documenter
+using Revise
+Revise.revise()
 
 DocMeta.setdocmeta!(IPUMS, :DocTestSetup, :(using IPUMS); recursive=true)
 
@@ -17,12 +19,12 @@ makedocs(;
     ),
     pages=[
         "Home" => "index.md",
+        "Workflows" => "workflow.md",
+        "How to " => "howto.md",
         "Tutorials" => "tutorials.md",
-        "HowTo" => "howto.md",
-        "Workflow" => "workflow.md",
         "Examples" => "examples.md",
         "Mission" => "mission.md",
-        "Contributing" => "contributing.md"
+        "References" => "references.md",
     ],
 )
 

docs/src/index.md

@@ -1,7 +1,3 @@
-```@meta
-CurrentModule = IPUMS
-```
-
 # IPUMS
 
 Documentation for [IPUMS](https://github.com/TheCedarPrince/IPUMS.jl).

src/models/model_DataExtract.jl

@@ -10,11 +10,16 @@
         status=nothing,
         downloadLinks=nothing,
     )
+This function extracts data giving the status and the download download links 
+# Arguments
 
-    - extractDefinition::DataExtractDefinition
-    - number::Int64
-    - status::String
-    - downloadLinks::DataExtractDownloadLinks
+    - `extractDefinition::DataExtractDefinition`
+    - `number::Int64`
+    - `status::String`
+    - `downloadLinks::DataExtractDownloadLinks`
+
+# Return
+It returns the definition and the data with their download status and the link
 """
 Base.@kwdef mutable struct DataExtract <: OpenAPI.APIModel
     extractDefinition = nothing # spec type: Union{ Nothing, DataExtractDefinition }

src/models/model_DataExtractDefinition.jl

@@ -16,6 +16,9 @@
         version=nothing,
         collection=nothing,
     )
+This function extracts data giving the data format, the time table, the breakdown and type of layout, the shape of the files, their geogrphic information, a description, the version and collection of data
+
+# Arguments
 
     - datasets::Dict{String, Dataset}
     - timeSeriesTables::Dict{String, TimeSeriesTable}
@@ -27,6 +30,8 @@
     - description::String
     - version::Int64
     - collection::String
+# Return
+The function return a new dataset
 """
 Base.@kwdef mutable struct DataExtractDefinition <: OpenAPI.APIModel
     datasets::Union{Nothing, Dict} = nothing # spec type: Union{ Nothing, Dict{String, Dataset} }

src/models/model_DataExtractDownloadLinks.jl

@@ -9,10 +9,15 @@
         tableData=nothing,
         gisData=nothing,
     )
+This function extracts data giving the codebook prview, the table data and gis data
 
+# Arguments
     - codebookPreview::String
     - tableData::String
     - gisData::String
+
+# Return
+The function returns new extracted data
 """
 Base.@kwdef mutable struct DataExtractDownloadLinks <: OpenAPI.APIModel
     codebookPreview::Union{Nothing, String} = nothing

src/models/model_DataExtractPost.jl

@@ -14,7 +14,9 @@
         geographicExtents=nothing,
         description=nothing,
     )
+This function extracts data giving the time series table,the format of the data, the table layout, the shape of the file, its geographic extent and the description 
 
+# Arguments
     - datasets::Dict{String, Dataset}
     - timeSeriesTables::Dict{String, TimeSeriesTable}
     - dataFormat::String
@@ -23,6 +25,8 @@
     - shapefiles::Vector{String}
     - geographicExtents::Vector{String}
     - description::String
+# Return 
+
 """
 Base.@kwdef mutable struct DataExtractPost <: OpenAPI.APIModel
     datasets::Union{Nothing, Dict} = nothing # spec type: Union{ Nothing, Dict{String, Dataset} }

src/models/model_DataExtractPostResponse.jl

@@ -1,4 +1,4 @@
-# This file was generated by the Julia OpenAPI Code Generator
+ # This file was generated by the Julia OpenAPI Code Generator
 # Do not modify this file directly. Modify the OpenAPI specification instead.
 
 
@@ -10,11 +10,16 @@
         status=nothing,
         downloadLinks=nothing,
     )
+This function extracts data giving a data definition,the status of the download and the link
 
+# Arguments
     - extractDefinition::DataExtractDefinition
     - number::Int64
     - status::String
     - downloadLinks::DataExtractDownloadLinks
+
+# Return 
+Returns a new table with data definition,numbers,status and the download link
 """
 Base.@kwdef mutable struct DataExtractPostResponse <: OpenAPI.APIModel
     extractDefinition = nothing # spec type: Union{ Nothing, DataExtractDefinition }

src/models/model_DataTableFull.jl

@@ -13,14 +13,18 @@
         datasetName=nothing,
         nVariables=nothing,
     )
+This function creates a table giving the nhgisCode, the description of the date, their universe and the dataset name
 
+# Attributes
     - name::String
     - nhgisCode::String
     - description::String
     - universe::String
     - sequence::Int64
     - datasetName::String
     - nVariables::Int64
+
+# Return
 """
 Base.@kwdef mutable struct DataTableFull <: OpenAPI.APIModel
     name::Union{Nothing, String} = nothing

src/models/model_DataTableFullVariablesInner.jl

@@ -8,9 +8,12 @@
         name=nothing,
         nhgisCode=nothing,
     )
-
+This function gives a table with the name of the data and their nhgiscode
+# Attributes
     - name::String
     - nhgisCode::String
+Retrurn
+
 """
 Base.@kwdef mutable struct DataTableFullVariablesInner <: OpenAPI.APIModel
     name::Union{Nothing, String} = nothing

src/models/model_DataTableSimple.jl

@@ -10,7 +10,7 @@
         description=nothing,
         sequence=nothing,
     )
-
+This function returns a table with name of data, description, sequence and nhgisCode 
     - name::String
     - nhgisCode::String
     - description::String

src/models/model_Dataset.jl

@@ -10,11 +10,15 @@
         breakdownValues=nothing,
         years=nothing,
     )
+This function creates a new data table giving geographical levels, breakdown values and years
 
+# Arguments
     - dataTables::Vector{String}
     - geogLevels::Vector{String}
     - breakdownValues::Vector{String}
     - years::Vector{String}
+
+
 """
 Base.@kwdef mutable struct Dataset <: OpenAPI.APIModel
     dataTables::Union{Nothing, Vector{String}} = nothing

src/models/model_DatasetFull.jl

@@ -14,6 +14,9 @@
         hasMultipleDataTypes=nothing,
         breakdowns=nothing,
     )
+This function creates a dataset giving the description and the group of the data, the sequence, the geographical information and if it has multiple data types and breakdowns.
+
+# Arguments
 
     - name::String
     - description::String
@@ -23,6 +26,8 @@
     - geogLevels::Vector{DatasetFullGeogLevelsInner}
     - hasMultipleDataTypes::Bool
     - breakdowns::DatasetFullBreakdowns
+# Return 
+The function returns a new table 
 """
 Base.@kwdef mutable struct DatasetFull <: OpenAPI.APIModel
     name::Union{Nothing, String} = nothing

src/models/model_DatasetFullBreakdowns.jl

@@ -12,13 +12,18 @@
         years=nothing,
         geographicInstances=nothing,
     )
+This function creates a dataset giving the description and the type of data, the sequence, the geographical ans year information and breakdowns.
 
+# Arguments
     - name::String
     - type::String
     - description::String
     - breakdownValues::Vector{DatasetFullBreakdownsBreakdownValuesInner}
     - years::Vector{String}
     - geographicInstances::Vector{DatasetFullBreakdownsBreakdownValuesInner}
+
+# Return
+The function returns a new dataset
 """
 Base.@kwdef mutable struct DatasetFullBreakdowns <: OpenAPI.APIModel
     name::Union{Nothing, String} = nothing

src/models/model_DatasetFullBreakdownsBreakdownValuesInner.jl

@@ -8,7 +8,7 @@
         name=nothing,
         description=nothing,
     )
-
+The fuction ge
     - name::String
     - description::String
 """

src/models/model_DatasetFullGeogLevelsInner.jl

@@ -9,10 +9,14 @@
         description=nothing,
         hasGeogExtentSelection=nothing,
     )
+This function gives the geographical information about data
 
+# Arguments
     - name::String
     - description::String
     - hasGeogExtentSelection::Bool
+# Return 
+The function return a new dataset
 """
 Base.@kwdef mutable struct DatasetFullGeogLevelsInner <: OpenAPI.APIModel
     name::Union{Nothing, String} = nothing

src/models/model_DatasetSimple.jl

@@ -10,11 +10,15 @@
         group=nothing,
         sequence=nothing,
     )
+The fuction gives a dataset given a group, a sequence,an input and a description 
 
+# Arguments
     - name::String
     - description::String
     - group::String
     - sequence::Int64
+# Return 
+The function returns a new dataset
 """
 Base.@kwdef mutable struct DatasetSimple <: OpenAPI.APIModel
     name::Union{Nothing, String} = nothing

src/models/model_Shapefile.jl

@@ -12,13 +12,16 @@
         basis=nothing,
         sequence=nothing,
     )
-
+This function creates a new file 
+# Aut
     - name::String
     - year::String
     - geographicLevel::String
     - extent::String
     - basis::String
     - sequence::Int64
+# Return 
+
 """
 Base.@kwdef mutable struct Shapefile <: OpenAPI.APIModel
     name::Union{Nothing, String} = nothing

src/models/model_TimeSeriesTable.jl

@@ -8,9 +8,16 @@
         geogLevels=nothing,
         years=nothing,
     )
+This function creates a table with geographical and time information
 
-    - geogLevels::Vector{String}
-    - years::Vector{String}
+# Arguments
+    - `geogLevels::Vector{String}`
+    - `years::Vector{String}`
+
+# Return
+The return of the function is a table 
+
+# Example
 """
 Base.@kwdef mutable struct TimeSeriesTable <: OpenAPI.APIModel
     geogLevels::Union{Nothing, Vector{String}} = nothing

src/models/model_TimeSeriesTableFull.jl

@@ -13,12 +13,19 @@
         geogLevels=nothing,
     )
 
-    - name::String
-    - description::String
-    - geographicIntegration::String
-    - sequence::Float32
-    - timeSeries::Vector{TimeSeriesTableFullTimeSeriesInner}
-    - geogLevels::Vector{TimeSeriesTableFullTimeSeriesInner}
+This function creates a table with fixed name,description, geographical and timeline information
+
+# Argument
+    - `name::String`
+    - `description::String`
+    - `geographicIntegration::String`
+    - `sequence::Float32`
+    - `timeSeries::Vector{TimeSeriesTableFullTimeSeriesInner}`
+    - `geogLevels::Vector{TimeSeriesTableFullTimeSeriesInner}`
+# Return
+The return is a new table with fixed name,description,time and geographical information of the data
+
+# Example
 """
 Base.@kwdef mutable struct TimeSeriesTableFull <: OpenAPI.APIModel
     name::Union{Nothing, String} = nothing

src/models/model_TimeSeriesTableFullTimeSeriesInner.jl

@@ -10,9 +10,18 @@
         sequence=nothing,
     )
 
-    - name::String
-    - description::String
-    - sequence::Int64
+  
+This function takes as input the name,the description and the sequence of data e and return a new table
+
+# Argument
+
+    - `name::String`
+    - `description::String`
+    - `sequence::Int64`
+# Return
+
+The return is a new table with fixed name and description
+
 """
 Base.@kwdef mutable struct TimeSeriesTableFullTimeSeriesInner <: OpenAPI.APIModel
     name::Union{Nothing, String} = nothing