search

jbytecode / LinRegOutliers

Direct and robust methods for outlier detection in linear regression
MIT License
44 stars 6 forks source link

Documentation - 2. Examples #41

Closed salleuska closed 3 years ago

salleuska commented 3 years ago

As for the documentation, I think that examples could clearer if expanded a bit. I like the fact that algorithms calls follow the same structure, the function usage is pretty self-explanatory. However, I would suggest expanding the example page to better reflect how the functions of the package help to perform data analysis. For example, providing few sentences describing the data, objective of the analysis and commenting the results. The example could also clarify that algorithms can provide different outputs, and that they all provide a list of outliers named outliers directly or contained in the Dictionary.

https://github.com/openjournals/joss-reviews/issues/2892

jbytecode commented 3 years ago

Dear reviewer @salleuska,

example page is updated with additional information about selected methods. An introduction section is added for better explanation of basic calling convention. The other calling convention is also mentioned. The datasets used in examples are also clarified.