Skip to content

Document input and output of generateIndex#763

Merged
lydiayliu merged 4 commits intomainfrom
czhu-fix-doc
Jul 5, 2023
Merged

Document input and output of generateIndex#763
lydiayliu merged 4 commits intomainfrom
czhu-fix-doc

Conversation

@zhuchcn
Copy link
Contributor

@zhuchcn zhuchcn commented Jul 5, 2023

Description

Improved documentation for input and output files of generateIndex

The link in vignette is also fixed.

Closes #

Checklist

  • This PR does NOT contain PHI or germline genetic data. A repo may need to be deleted if such data is uploaded. Disclosing PHI is a major problem.
  • This PR does NOT contain molecular files, compressed files, output files such as images (e.g. .png, .jpeg), .pdf, .RData, .xlsx, .doc, .ppt, or other non-plain-text files. To automatically exclude such files using a .gitignore file, see here for example.
  • I have read the code review guidelines and the code review best practice on GitHub check-list.
  • The name of the branch is meaningful and well formatted following the standards, using [AD_username (or 5 letters of AD if AD is too long)]-[brief_description_of_branch].
  • I have added the major changes included in this pull request to the CHANGELOG.md under the next release version or unreleased, and updated the date.
  • All test cases passed locally.

@zhuchcn zhuchcn requested review from alkaZeltser and lydiayliu July 5, 2023 17:40
Copy link
Contributor

@lydiayliu lydiayliu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you double check my minor updates to the doc?

@lydiayliu lydiayliu merged commit ed798fc into main Jul 5, 2023
@lydiayliu lydiayliu deleted the czhu-fix-doc branch July 5, 2023 19:35
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

Successfully merging this pull request may close these issues.

2 participants