Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Leightweight sfa class #58

Open
matthiasgomolka opened this issue Mar 18, 2024 · 0 comments
Open

Leightweight sfa class #58

matthiasgomolka opened this issue Mar 18, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@matthiasgomolka
Copy link
Owner

Every sfa_* function requires two inputs: api_key = getOption("sfa_api_key") and cache_dir = getOption("sfa_cache_dir"). If we would implement a simple class which stores these two arguments, all existing functions could be implemented as methods of this class. All these methods would be simplified because the arguments above would be already set.

The syntax would look something like this:

sfa <- SimFinAPI(api_key = ..., cache_dir = ...) # instantiate the class

sfa$load_companies()

If we ever get to offer bulk downloads as well, this might also be beneficial since the class object could be used to keep track of already downloaded files.

@matthiasgomolka matthiasgomolka self-assigned this Mar 18, 2024
@matthiasgomolka matthiasgomolka added the enhancement New feature or request label Mar 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant