New package: SFA v0.1.0

[JuliaRegistrator]

• Registering package: SFA
• Repository: https://github.com/fps/SFA.jl
• Created by: @fps
• Version: v0.1.0
• Commit: ced463e0a9dcb6231b689d6650b10fa320cbbc1b
• Reviewed by: @fps
• Reference: fps/SlowFeatureAnalysis.jl@ced463e#commitcomment-182451402
• Description: Slow Feature Analysis for Julia

[github-actions]

Hello, I am an automated registration bot. I help manage the registration process by checking your registration against a set of AutoMerge guidelines. If all these guidelines are met, this pull request will be merged automatically, completing your registration. It is strongly recommended to follow the guidelines, since otherwise the pull request needs to be manually reviewed and merged by a human.

1. New package registration

Please make sure that you have read the package naming guidelines.

2. AutoMerge Guidelines which are not met ❌

• Name does not meet all of the following: starts with an upper-case letter, ASCII alphanumerics only, not all letters are upper-case.

• Name is not at least 5 characters long

• I was not able to install the package (i.e. Pkg.add("SFA") failed). See the AutoMerge logs for details.

• I was not able to load the package (i.e. import SFA failed). See the AutoMerge logs for details.

• Package name similar to 18 existing packages.

  Similar package names

  1. Similar to SHA. Damerau-Levenshtein distance 1 is at or below cutoff of 2. Damerau-Levenshtein distance 1 between lowercased names is at or below cutoff of 1. Normalized visual distance 1.52 is at or below cutoff of 2.50.
  2. Similar to SOFA. Damerau-Levenshtein distance 1 is at or below cutoff of 2. Damerau-Levenshtein distance 1 between lowercased names is at or below cutoff of 1.
  3. Similar to SPH. Damerau-Levenshtein distance 2 is at or below cutoff of 2. Normalized visual distance 1.67 is at or below cutoff of 2.50.
  4. Similar to XPA. Damerau-Levenshtein distance 2 is at or below cutoff of 2. Normalized visual distance 2.47 is at or below cutoff of 2.50.
  5. Similar to SEAL. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
  6. Similar to SOM. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
  7. Similar to SMM. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
  8. Similar to FCA. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
  9. Similar to SCS. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
  10. Similar to SMC. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
  11. Similar to SVR. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
  12. Similar to STAC. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
  13. Similar to STFT. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
  14. Similar to SIAN. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
  15. Similar to SDPA. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
  16. Similar to ERFA. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
  17. Similar to FFTA. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
  18. Similar to ALFA. Damerau-Levenshtein distance 2 is at or below cutoff of 2.

3. Needs action: here's what to do next

1. Please try to update your package to conform to these guidelines. The General registry's README has an FAQ that can help figure out how to do so.
2. After you have fixed the AutoMerge issues, simply retrigger Registrator, the same way you did in the initial registration. This will automatically update this pull request. You do not need to change the version number in your Project.toml file (unless the AutoMerge issue is that you skipped a version number).

If you need help fixing the AutoMerge issues, or want your pull request to be manually merged instead, please post a comment explaining what you need help with or why you would like this pull request to be manually merged. Then, send a message to the #pkg-registration channel in the public Julia Slack for better visibility.

4. To pause or stop registration

If you want to prevent this pull request from being auto-merged, simply leave a comment. If you want to post a comment without blocking auto-merging, you must include the text [noblock] in your comment.

Tip: You can edit blocking comments to add [noblock] in order to unblock auto-merging.

[goerz]

It probably would be best to write out the acronym and name the package SlowFeatureAnalysis.jl. You can still recommend in your README that people use the package as

using SlowFeatureAnalysis: SlowFeatureAnalysis as SFA

[goerz]

Closing in favor of #153012

[fps]

Thanks a bunch :)

[GunnarFarneback]

How did you create your compat?

[compat]
MultivariateStats = "~0.10"
julia = "~1.11"

The tilde means that this is only going to be compatible with Julia 1.11.x, but not with the current 1.12 release or future releases.

[fps]

Yes, since I'm still using 1.11 and not 1.12 I cannot vouch for compatibility on 1.12. I'll migrate to 1.12 at some point in the future and then I can update the compat..

[GunnarFarneback]

That is overly pessimistic. Unless you are using non-public functionality, the default assumption should be that your code will keep working when you increase Julia's minor version number.

[goerz]

I would also add that even if you haven't personally upgraded to 1.12 yet, you can run continuous integration in GitHub Actions, using the current Julia 1.12 version by default. To that end (and also to just ensure the basic functionality of the package), I would strongly recommend that you add a test suite and a CI.yml workflow. You will find examples for this setup in most other Julia packages.