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

make more plotting functions available to user #191

Closed
3 of 4 tasks
drbenvincent opened this issue Jun 2, 2017 · 2 comments
Closed
3 of 4 tasks

make more plotting functions available to user #191

drbenvincent opened this issue Jun 2, 2017 · 2 comments

Comments

@drbenvincent
Copy link
Owner

drbenvincent commented Jun 2, 2017

At the moment we have some plot functions available for the user to call, but we should have more (if not all) of these available. We need to be able to 'fit' a model, and then construct the figures and then call whichever plot methods we need to construct figures for a paper.

  • Make functions available.
  • Provide function help text to help the user know how to call the functions
  • Add tests to ensure the plotting API's don't break. Exercise some caution as we'll assume these will remain available.
  • Document the plotting functions in the wiki.

This issue will go some way towards #141.

drbenvincent pushed a commit that referenced this issue Jun 2, 2017
- more methods now user-callable
- renaming some methods
- consistent way of dealing with requested figure/subplot t plot to
drbenvincent pushed a commit that referenced this issue Jun 2, 2017
(think I forgot to stage this last time)
@drbenvincent
Copy link
Owner Author

Current plot methods available:

  • plot
  • plotDiscountFunction
  • plotDiscountFunctionGrid
  • plotDiscountFunctionsOverlaid
  • plotExperimentOverviewFigure
  • plotPosteriorAUC
  • plotPosteriorClusterPlot
  • plotPosteriorCornerPlot
  • plotPosteriorDiscountFunctionParams
  • plotPsychometricFunction
  • plotSubjectiveTimeFunction
  • plotUnivarateSummary

@drbenvincent
Copy link
Owner Author

At the moment we have either zero required arguments to these plot functions, or just a specification of which experiment number we wish to plot. All plot methods can take in optional varargin arguments which allows future extension to provide additional arguments to customise the plots. This will allow #141 to be dealt with.

I will avoid documenting these functions at this point... it falls into the category of 'reference' which is perhaps best dealt with by in-code help text etc. Instead, I will (at some point) add some more high-level examples in the wiki to demonstrate their use and refer back to the in-code function help for detailed info.

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

No branches or pull requests

1 participant