Input types

[MartinuzziFrancesco]

Living collection of input types that would be nice to include in SpectralIndices.jl

• DataFrames added with Dispatched compute_index on DataFrames  #5
• YAXArrays added in Dispatch over YAXArrays #9
• NamedTuples added in Dispatch over NamedTuples #33
• Tables Tables Ext #65
• GeoDataFramesWe should get this for free from DataFrames unless I'm missing something
• Rasters Uses DimensionalData as backend like YAXArrays, it should be relatively easy to extend the existing code to cover Rasters as well. WIP in Rasters Ext #41
• DimensionalData
• AxisArrays
• NamedDims
• NamedArrays
• AxisKeys
• GeoArrays

If you would like to see any other type of array represented here please comment on this issue

List of methods and additions to make to the package for each new data type:

• Dispatch on _check_params(index, params::NewType)
• Dispatch on _order_params(index, params::NewType)
• Dispatch on _create_params(kw_args::Pair{Symbol,<:NewType}...)
• Dispatch on compute_index(index::String, params::NewType)
• Dispatch on compute_index(index::Vector{String}, params::NewType)
• Dispatch on _compute_index(idx::AbstractSpectralIndex, prms::NewType...)
• Dispatch on linear(params::NewType)
• Dispatch on poly(params::NewType)
• Dispatch on RBF(params::NewType)
• (optional) Dispatch on `load_dataset(dataset::String, ::Type{T}) where {T<:NewType}'
• Add documentation under "Tutorials" with NewTypes.jl title and through examples for all the new methods
• Add testing:
  • Create a folder in test with the name of the package containing NewType
  • Add compute_index.jl test file
  • Add compute_kernel.jl test file
  • Add datasets.jl test file
  • Include test files in runtest.jl

[gdkrmr]

• The tables interface would go a long way, I think!
• Named Tuples. They could maybe be a performance gain over Dicts because they don't require allocations, maybe they even work out of the box, because you can just splat them as named arguments:

julia> f(;x = 1, y = 2) = x + y
f (generic function with 1 method)

julia> f(;(x = 1, y = 2)...)
6

[MartinuzziFrancesco]

thanks, I've updated the comment! I'll do some tests with namedtuples, they should just work as you said, but they also need to work as argument input so maybe that'll require a dispatch