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

Easier and Detailed Documentation with Examples #185

Closed
Sinansi opened this issue Mar 8, 2020 · 4 comments
Closed

Easier and Detailed Documentation with Examples #185

Sinansi opened this issue Mar 8, 2020 · 4 comments

Comments

@Sinansi
Copy link

Sinansi commented Mar 8, 2020

I kindly ask the owners of this library to provide easier and more detailed documentation.
I find it challenging to use this library, despite how straight forward it should be. Not all people have PhD and acquainted with Julia like you do. It would be great if you can provide examples.

Regarding, the Augmented Dickey-Fuller test, I am trying to follow the documentation, but keep getting errors.

random_vector = rand(1000)

HypothesisTests.ADFTest(random_vector)
Not working

HypothesisTests.ADFTest(random_vector, 2)
Not working

HypothesisTests.ADFTest(random_vector, "none", 2)
Not working

HypothesisTests.ADFTest(y=random_vector, deterministic="none", lag=2)
Not working

Can someone solve the enigma? How does this function like to take its arguments?

Thank you!

@Sinansi
Copy link
Author

Sinansi commented Mar 10, 2020

Anyone can help on this issue please?

@Sinansi
Copy link
Author

Sinansi commented Mar 10, 2020

Now I understand why Julia keep falling against Python in popularity, and soon it is going to get kicked out of the TIOBE index. The documentation is not as friendly as in Python.

Not sure why Julia software developers prevent declaring the data type and data shape of function arguments in their documentation. I found in the source code that the arguments have to be passed as symbols, not as string as widely known.

I assumed I could get help on this issue, but very friendly community indeed.

Thank you!

@Sinansi Sinansi closed this as completed Mar 10, 2020
@matbesancon
Copy link
Member

I am not qualified to answer here, not being familiar with the package, but for help questions like this, you should try asking on a more Q&A oriented platform (developers are more likely to keep issues for development issue and help out on forums).
Check out the different ways to reach the julia community here: julialang.org/community/
The best format may be discourse:
discourse.julialang.org

@ararslan
Copy link
Member

Hi @Sinansi. Please note that this issue was open only for a couple of days. The developers are all busy folks with other commitments who are volunteering their time to develop and maintain packages like this. Although we try our best to do so, we may not be able to respond to issues right away. For immediate feedback on questions, I encourage you to post on the Julia Discourse forum.

If you've figured out how to solve your problem, I encourage you to contribute your knowledge to the package in the form of a pull request. That will help other folks with your same question about the interface.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants