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

[DOCS] Documentation for user #33

Open
14 of 22 tasks
zhao-cy opened this issue Dec 23, 2021 · 0 comments
Open
14 of 22 tasks

[DOCS] Documentation for user #33

zhao-cy opened this issue Dec 23, 2021 · 0 comments
Assignees

Comments

@zhao-cy
Copy link
Collaborator

zhao-cy commented Dec 23, 2021

  • how to install libhdf5-dev package on a Mac computer: $ brew install hdf5 <== update this in Readme.Rmd (NOT .md on frontpage!!!)
  • docs of functions
    • add explanations of stat outputs: link to broom package's explanations (lm, gam respectively)
    • add a table explaning var.*, full.outputs, correct.p.values.*
  • demos
    • main page !!
      • display on main page of github
      • display on main page of github.io/modelarray
    • main scope of ModelArray
      • add example of p.value corrections for ModelArray.gam() - as it's different from .lm()
    • major part of doc for user:
      • make this sentence clearer (per Joelle suggestion): The requirement of this .csv: There must be a column of “source_file”, providing the relative filepath of the source image file. This requirement is consistent with that in ConFixel - please see ConFixel's docs [link] for how to set up the .csv file if you haven't run ConFixel already.
      • example of smooth term with interaction term (e.g. s(age, by=oSex)
    • side topics, e.g. basic uses of R
      • how to check if a model is well-conditioned
  • check pkgdown's display (github.io/modelarray):
    • fix the quick view page (e.g. in slack): "What the package does (one paragraph)."
    • fix "on this page": "#" is not displayed, but "##" does. Try lower all levels by one.
  • pkgdown:
@zhao-cy zhao-cy added this to the manuscript ready milestone Mar 13, 2022
@zhao-cy zhao-cy changed the title [ENH] Documentation for user [DOCS] Documentation for user Apr 17, 2022
@zhao-cy zhao-cy self-assigned this May 2, 2022
@zhao-cy zhao-cy removed this from the manuscript ready milestone May 13, 2022
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

1 participant