-
Notifications
You must be signed in to change notification settings - Fork 1k
Support
-
If you encounter an error message you don't understand, go immediately to Stack Overflow. In the top right of the screen type in the search box "[data.table]" followed by the actual error message. [add screenshot] Yes, copy and paste the actual error message (or most salient parts from it) since the error message will appear in the text of good questions. If you get no results then you could try the "[r]" tag in case a question has been asked about that error message but not tagged data.table. If so, please edit that question and add [data.table] alongside the [r] tag if and only if the question (not the answer) was about data.table.
-
If you don't know how to do something then :
- Again, search the data.table tag on Stack Overflow using English. [add screenshot]
- Type
?data.table
and look at all the arguments. Do you know them all? Make sure you do. It is likely that one of them is there for your task. If some seem like they could help, search Stack Overflow for that argument name within the [data.table] and see how people have used it. Many answers use data.table but the question was not about data.table, so in this situation search in the [r] tag (not data.table) for the data.table string and the argument name. - Have a look at the data.table FAQ. Read all the FAQs anyway, even if you don't have those questions. The FAQ is considered documentation (i.e. required reading) just structured in a FAQ style.
-
Read and search the README.md. Is there a bug fix or a new feature related to your issue? Probably we were aware of the issue or someone else reported it and we have already fixed the issue in the current development version.
-
Even if your issue is not listed in the README.md file, please test your code on the latest version from Github to ensure that the problem still exists. Installation instructions can be found here. It is trivial to downgrade again back to the CRAN release and the one line commands are on that page too.
-
Look through the existing tickets (use the search) to check if the issue has already been reported. It's much easier for you to look for duplicates on that one issue, rather than us having to check for all reported issues! It's encouraged to add a comment "+1" if you have the same feature or bug report. That helps us prioritize.
If your problem survives the above steps AND you are reasonably sure it is either a bug report or a feature request then raise a new issue on the GitHub project. Please tag it bug or feature request appropriately. Project members and anyone subscribed to activity on the project will be notified via email, likely via an email folder (i.e. a queue). OTHERWISE, ask a new question on Stack Overflow. Be sure to tag the question both [r] and [data.table]. For example your question may be "is this a bug?" and if confirmed you may then be advised to raise an issue. If so, please include a link to the question in the new issue.
When asking on Stack Overflow or filing a new bug report, the following steps are required.
- Read how to ask.
- A minimal reproducible example of the issue must be provided -- should be possible in most cases. Read how to make a great R reproducible example.
- Please read the github flavoured markdown page on formatting your code, if you are not already aware of it.
- Please do not add
>
in your code -- makes it difficult to copy/paste your code. - What is the intended behaviour? And what do you get instead? Please show the output code wherever applicable - use "#" to comment the output parts so that we can copy/paste the code without any issues.
- If you encounter an issue with
fread
, provide the output by running with the optionverbose=TRUE
. Also, provide an external link to the minimal reproducible file, and use that file name in your code. It'd also be great if you don't delete the link anytime soon, as we may not be able to get to your issue immediately. - If the issue happens when loading another package, or the issue is when using data.table with another package, please add the package name and it's version as well. And if the package has a non-straightforward installation procedure, please list it as well.
- What is your R version, and data.table version? Better to post the
sessionInfo()
output. Again, please comment the output with "#", and remove the ">".
In addition to the above mandatory steps, any additional information is most definitely welcome!
Thank you very much!