Deprecate gSSURGO.Query() #3697

[shivpratikhande]

…G #3697

Description

Marked the gSSURGO.Query() function as deprecated:

• Added @deprecated roxygen tag.
• Added .Deprecated("extract_soil_gssurgo") at the top of the function.
• Kept the rest of the function as-is.
• Updated NEWS.md and CHANGELOG.md with deprecation notes.
• Documented the deprecation process in the coding style section.

No tests were related to this function.

Motivation and Context

This change informs users that gSSURGO.Query() is deprecated and directs them to use extract_soil_gssurgo() from soilDB instead.
It prepares the function for removal in a future release and links to the issue #3697.

Review Time Estimate

• Immediately
• Within one week
• When possible

Types of changes

• Chore / Maintenance
• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• My change requires a change to the documentation.
• My name is in the list of CITATION.cff
• I agree that PEcAn Project may distribute my contribution under any or all of
  • the same license as the existing code,
  • and/or the BSD 3-clause license.
• I have updated the CHANGELOG.md.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• All new and existing tests passed.

[dlebauer]

Awesome - that's perfect, thank you for your contribution!

fixes #3697

[dlebauer]

actually, I think you need to run make document or devtools::document('modules/data.land') and check in the updated Rd file first.

[dlebauer]

looks great, thanks for your help @divine7022!

[divine7022]

run devtools::document("modules/data.land") and commit modules/data.land/man/gSSURGO.Query.Rd then it's read to merge

[dlebauer]

Oddly, it seems like the most recent commit removed the part we want (documentation of deprecation) f36090a

[shivpratikhande]

Oh, my bad
I didn’t realize the deprecation note got removed
I’ll fix the file; would you prefer I update this PR or open a new one?

[divine7022]

Just regenerate the docs using devtools::document("modules/data.land")
This will auto-generate modules/data.land/man/gSSURGO.Query.Rd , no need to edit it manually since it's produced from the roxygen comments.
After regeneration commit the updated .Rd file.

[divine7022]

please run devtools::document("modules/data.land") along and commit .Rd file

[divine7022]

Suggested change

	#' `gSSURGO.Query()` was deprecated in PEcAn 1.8.0.
	#' `gSSURGO.Query()` is deprecated, please use `PEcAn.data.land::extract_soil_gssurgo()` instead (see issue #3697).
	#' `gSSURGO.Query()` is deprecated, please use `PEcAn.data.land::extract_soil_gssurgo()` instead (see issue #3697).

Change has been addressed.

[infotroph]

@shivpratikhande I'm going to close this PR now and request that any pivoting to seealso (as discussed in #3697) happens in a new PR -- that way when we ARE ready to deprecate it, there's a chance we can come back to this PR as a starting point :)

Thanks again for the quick implementation and for understanding as the requirements evolved.