Refactor SurveyDesign and add in-place constructor

This commit introduces a significant refactor to the `SurveyDesign` struct in the `SurveyDesign.jl` file. A new in-place constructor function, `SurveyDesign!`, has been added to allow for direct manipulation of the passed `AbstractDataFrame`. This change aims to enhance the flexibility and efficiency of survey design creation by providing an option to modify the data frame in place.

Additionally, minor formatting adjustments were made to improve code readability and consistency across the file. These include alignment of default parameter values and minor adjustments to spacing and line breaks.

The introduction of the `SurveyDesign!` function follows the Julia convention of using the `!` suffix to indicate functions that modify their arguments in place. This change is expected to make the API more intuitive for users familiar with Julia conventions.

Overall, this refactor and the addition of the in-place constructor enhance the library's usability and maintainability.

src/SurveyDesign.jl

@@ -54,10 +54,22 @@ struct SurveyDesign <: AbstractSurveyDesign
     # Single stage clusters sample, like apiclus1
     function SurveyDesign(
         data::AbstractDataFrame;
-        clusters::Union{Nothing,Symbol,Vector{Symbol}} = nothing,
-        strata::Union{Nothing,Symbol} = nothing,
-        popsize::Union{Nothing,Symbol} = nothing,
-        weights::Union{Nothing,Symbol} = nothing,
+        clusters::Union{Nothing,Symbol,Vector{Symbol}}=nothing,
+        strata::Union{Nothing,Symbol}=nothing,
+        popsize::Union{Nothing,Symbol}=nothing,
+        weights::Union{Nothing,Symbol}=nothing,
+    )
+        # call SurveyDesign!
+        SurveyDesign!(data; clusters=clusters, strata=strata, popsize=popsize, weights=weights)
+    end
+
+    # Function to manipulate the dataframe in place with ! added to its name
+    function SurveyDesign!(
+        data::AbstractDataFrame;
+        clusters::Union{Nothing,Symbol,Vector{Symbol}}=nothing,
+        strata::Union{Nothing,Symbol}=nothing,
+        popsize::Union{Nothing,Symbol}=nothing,
+        weights::Union{Nothing,Symbol}=nothing,
     )
         # sampsize here is number of clusters completely sampled, popsize is total clusters in population
         if typeof(strata) <: Nothing
@@ -99,8 +111,8 @@ struct SurveyDesign <: AbstractSurveyDesign
                 data[!, popsize] = data[!, sampsize_labels] .* data[!, weights_labels]
             end
         elseif isa(popsize, Symbol)
-                weights_labels = :_weights
-                data[!, weights_labels] = data[!, popsize] ./ data[!, sampsize_labels]
+            weights_labels = :_weights
+            data[!, weights_labels] = data[!, popsize] ./ data[!, sampsize_labels]
         else
             # neither popsize nor weights given
             weights_labels = :_weights
@@ -122,6 +134,7 @@ struct SurveyDesign <: AbstractSurveyDesign
             pps,
         )
     end
+
 end
 
 """
@@ -305,31 +318,31 @@ struct ReplicateDesign{ReplicateType} <: AbstractSurveyDesign
         type::String,
         replicates::UInt,
         replicate_weights::Vector{Symbol},
-    ) where {ReplicateType <: InferenceMethod}
+    ) where {ReplicateType<:InferenceMethod}
         new{ReplicateType}(data, cluster, popsize, sampsize, strata, weights, allprobs,
-           pps, type, replicates, replicate_weights, ReplicateType(replicates))
+            pps, type, replicates, replicate_weights, ReplicateType(replicates))
     end
 
     # constructor with given replicate_weights
     function ReplicateDesign{ReplicateType}(
         data::AbstractDataFrame,
         replicate_weights::Vector{Symbol};
-        clusters::Union{Nothing,Symbol,Vector{Symbol}} = nothing,
-        strata::Union{Nothing,Symbol} = nothing,
-        popsize::Union{Nothing,Symbol} = nothing,
-        weights::Union{Nothing,Symbol} = nothing
-    ) where {ReplicateType <: InferenceMethod}
+        clusters::Union{Nothing,Symbol,Vector{Symbol}}=nothing,
+        strata::Union{Nothing,Symbol}=nothing,
+        popsize::Union{Nothing,Symbol}=nothing,
+        weights::Union{Nothing,Symbol}=nothing
+    ) where {ReplicateType<:InferenceMethod}
         # rename the replicate weights if needed
-        rename!(data, [replicate_weights[index] => "replicate_"*string(index) for index in 1:length(replicate_weights)])
+        rename!(data, [replicate_weights[index] => "replicate_" * string(index) for index in 1:length(replicate_weights)])
 
         # call the SurveyDesign constructor
         base_design = SurveyDesign(
-                        data;
-                        clusters=clusters,
-                        strata=strata,
-                        popsize=popsize,
-                        weights=weights
-                      )
+            data;
+            clusters=clusters,
+            strata=strata,
+            popsize=popsize,
+            weights=weights
+        )
         new{ReplicateType}(
             base_design.data,
             base_design.cluster,
@@ -350,11 +363,11 @@ struct ReplicateDesign{ReplicateType} <: AbstractSurveyDesign
     ReplicateDesign{ReplicateType}(
         data::AbstractDataFrame,
         replicate_weights::UnitRange{Int};
-        clusters::Union{Nothing,Symbol,Vector{Symbol}} = nothing,
-        strata::Union{Nothing,Symbol} = nothing,
-        popsize::Union{Nothing,Symbol} = nothing,
-        weights::Union{Nothing,Symbol} = nothing
-    ) where {ReplicateType <: InferenceMethod} =
+        clusters::Union{Nothing,Symbol,Vector{Symbol}}=nothing,
+        strata::Union{Nothing,Symbol}=nothing,
+        popsize::Union{Nothing,Symbol}=nothing,
+        weights::Union{Nothing,Symbol}=nothing
+    ) where {ReplicateType<:InferenceMethod} =
         ReplicateDesign{ReplicateType}(
             data,
             Symbol.(names(data)[replicate_weights]);
@@ -368,11 +381,11 @@ struct ReplicateDesign{ReplicateType} <: AbstractSurveyDesign
     ReplicateDesign{ReplicateType}(
         data::AbstractDataFrame,
         replicate_weights::Regex;
-        clusters::Union{Nothing,Symbol,Vector{Symbol}} = nothing,
-        strata::Union{Nothing,Symbol} = nothing,
-        popsize::Union{Nothing,Symbol} = nothing,
-        weights::Union{Nothing,Symbol} = nothing
-    ) where {ReplicateType <: InferenceMethod} =
+        clusters::Union{Nothing,Symbol,Vector{Symbol}}=nothing,
+        strata::Union{Nothing,Symbol}=nothing,
+        popsize::Union{Nothing,Symbol}=nothing,
+        weights::Union{Nothing,Symbol}=nothing
+    ) where {ReplicateType<:InferenceMethod} =
         ReplicateDesign{ReplicateType}(
             data,
             Symbol.(names(data)[findall(name -> occursin(replicate_weights, name), names(data))]);