-
Notifications
You must be signed in to change notification settings - Fork 64
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1,326 changed files
with
59,334 additions
and
42,926 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
*.ix | ||
test_data/large.chrom.sizes | ||
packages/core/ui/react-colorful.js | ||
plugins/legacy-jbrowse/test_data | ||
plugins/data-management/src/ucsc-trackhub/ucscAssemblies.ts | ||
plugins/circular-view/test_data/circos_example_content.txt | ||
plugins/circular-view/test_data/circos_example.svg | ||
products/jbrowse-web/src/tests/Loader.test.tsx | ||
test_data/yeast_synteny/ | ||
test_data/hg38_aliases.txt | ||
test_data/config_honeybee.json | ||
test_data/amel_hav3.1.chrom.sizes | ||
plugins/wiggle/src/util.ts | ||
plugins/protein/src/ProteinReferenceSequenceRenderer/aminoAcids.js | ||
plugins/spreadsheet-view/src/SpreadsheetView/test_data/starfusion_example.fusion_predictions.tsv | ||
products/jbrowse-aws-lambda-functions/ | ||
products/jbrowse-desktop/src/JBrowse.test.tsx | ||
test_data/volvox/names/ | ||
products/jbrowse-web/src/sessionSharing.ts | ||
website/docs/models/ | ||
*.snap |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,3 +15,4 @@ | |
# JSON files we don't want to format | ||
**/*nclist*/**/*.json | ||
**/ensembl_genes/**/*.json | ||
**/storybook-static/* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,9 +5,9 @@ | |
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, sex characteristics, gender identity and expression, | ||
level of experience, education, socio-economic status, nationality, personal | ||
appearance, race, religion, or sexual identity and orientation. | ||
size, disability, ethnicity, sex characteristics, gender identity and | ||
expression, level of experience, education, socio-economic status, nationality, | ||
personal appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
|
@@ -37,11 +37,11 @@ Project maintainers are responsible for clarifying the standards of acceptable | |
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
Project maintainers have the right and responsibility to remove, edit, or reject | ||
comments, commits, code, wiki edits, issues, and other contributions that are | ||
not aligned to this Code of Conduct, or to ban temporarily or permanently any | ||
contributor for other behaviors that they deem inappropriate, threatening, | ||
offensive, or harmful. | ||
|
||
## Scope | ||
|
||
|
@@ -55,20 +55,22 @@ a project may be further defined and clarified by project maintainers. | |
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at [email protected]. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
reported by contacting the project team at [email protected]. | ||
All complaints will be reviewed and investigated and will result in a response | ||
that is deemed necessary and appropriate to the circumstances. The project team | ||
is obligated to maintain confidentiality with regard to the reporter of an | ||
incident. Further details of specific enforcement policies may be posted | ||
separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
version 1.4, available at | ||
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -41,8 +41,8 @@ yarn | |
yarn start | ||
``` | ||
|
||
You can edit the markdown by hand. The documentation is built into a website | ||
and a PDF using latex here http://jbrowse.org/jb2/jbrowse2.pdf | ||
You can edit the markdown by hand. The documentation is built into a website and | ||
a PDF using latex here http://jbrowse.org/jb2/jbrowse2.pdf | ||
|
||
### Adding images to the docs | ||
|
||
|
@@ -55,8 +55,8 @@ line in the markdown | |
Your caption of the image here | ||
``` | ||
|
||
This creates a caption of the image properly in the PDF, and just shows the | ||
text below the image on the website | ||
This creates a caption of the image properly in the PDF, and just shows the text | ||
below the image on the website | ||
|
||
## Developers | ||
|
||
|
@@ -78,21 +78,19 @@ script: | |
need to generate an access token. | ||
|
||
- Make sure you have a GitHub access token with public_repo scope. To generate | ||
one, go to https://github.com/settings/tokens, click "Generate new token," | ||
add a note describing what you want the token to be for, select the | ||
"public_repo" checkbox (under "repo"), and then click "Generate token." Make | ||
sure to save this token in a safe place to use for future releases as you | ||
won't be able to see it again. If you do lose your token, delete/revoke the | ||
token you lost and generate a new one. | ||
one, go to https://github.com/settings/tokens, click "Generate new token," add | ||
a note describing what you want the token to be for, select the "public_repo" | ||
checkbox (under "repo"), and then click "Generate token." Make sure to save | ||
this token in a safe place to use for future releases as you won't be able to | ||
see it again. If you do lose your token, delete/revoke the token you lost and | ||
generate a new one. | ||
|
||
- Decide if the release should have a major, minor, or patch level version | ||
increase. All packages that are published will get the same version number. | ||
|
||
Run the script like this: | ||
|
||
``` | ||
scripts/release.sh myGitHubAuthToken versionIncreaseLevel | ||
``` | ||
`scripts/release.sh myGitHubAuthToken versionIncreaseLevel` | ||
|
||
If you don't provide `versionIncreaseLevel`, it will default to "patch". | ||
|
||
|
@@ -104,9 +102,9 @@ those to the release as well. | |
Once the draft release has been created (you can look for it | ||
[here](https://github.com/GMOD/jbrowse-components/releases)), go to the release | ||
and click "Edit," then add a description to the release. Usually you can copy | ||
the content of the blog post that was generated (it will be named something | ||
like `website/blog/${DATE}-${RELEASE_TAG}-release.md`), removing the | ||
"Downloads" section. | ||
the content of the blog post that was generated (it will be named something like | ||
`website/blog/${DATE}-${RELEASE_TAG}-release.md`), removing the "Downloads" | ||
section. | ||
|
||
Note that it is very helpful to run the release from a computer with a stable | ||
and fast internet connection. One option for this is to run it from a AWS | ||
|
@@ -126,8 +124,8 @@ uploaded, the workflows will refuse to add them to the published release since | |
it looks for draft releases) | ||
|
||
Finally, run the update_demos.sh script from within the demos folder of the | ||
monorepo after the packages have been published. This will update the `demos` | ||
to use the latest version, and then publish them to our S3 bucket e.g. at | ||
monorepo after the packages have been published. This will update the `demos` to | ||
use the latest version, and then publish them to our S3 bucket e.g. at | ||
https://jbrowse.org/demos/lgv | ||
|
||
## Monorepo code organization | ||
|
@@ -179,10 +177,8 @@ This package provides the "alignments" related features including | |
|
||
- BamAdapter - our BAM parser that wraps @gmod/bam NPM module | ||
- CramAdapter - our CRAM parser that wraps the @gmod/cram NPM module | ||
- PileupTrack type - draws alignments as boxes in a "pileup" style view | ||
- SNPCoverageTrack - draws calculated coverage with mismatches drawn over the coverage | ||
- AlignmentsTrack - a "supertrack" which contains a PileupTrack and | ||
SNPCoverageTrack "subtracks" | ||
- AlignmentsTrack - a "supertrack" which contains a PileupDisplay and | ||
SNPCoverageDisplay "subtracks" | ||
- AlignmentsFeatureWidget for alignments features | ||
|
||
#### plugins/variants/ | ||
|
@@ -192,8 +188,8 @@ Provides variant features including | |
- VCF tabix parser | ||
- VCF non-tabix parser | ||
- VariantFeatureWidget | ||
- VariantTrack that is basically just a normal track, but has logic to popup | ||
the VariantFeatureWidget on feature click | ||
- VariantTrack that is basically just a normal track, but has logic to popup the | ||
VariantFeatureWidget on feature click | ||
|
||
#### plugins/hic | ||
|
||
|
@@ -231,8 +227,8 @@ General usage of this involves referencing the SvgFeatureRenderer | |
|
||
#### plugins/spreadsheet-view | ||
|
||
This provides a spreadsheet-in-the-browser that can be used as a data backend | ||
to power other views | ||
This provides a spreadsheet-in-the-browser that can be used as a data backend to | ||
power other views | ||
|
||
#### plugins/circular-view | ||
|
||
|
@@ -278,8 +274,22 @@ jbrowse text-index -a hg19 --tracks ncbi_gff_hg19 --out config_demo.json --force | |
|
||
## Notes about monorepo setup | ||
|
||
Our setup for the monorepo takes notes from the material-ui repository. Some particular notes include | ||
Our setup for the monorepo takes notes from the material-ui repository. Some | ||
particular notes include | ||
|
||
1. The use of the "flat" packages/core package, where you can import from nested subpaths like '@jbrowse/core/util' | ||
1. The use of the "flat" packages/core package, where you can import from nested | ||
subpaths like '@jbrowse/core/util' | ||
2. The use of tsconfig.build.json to generate types in the final release | ||
3. The use of referring to the src directory at development time | ||
|
||
## Notes about yarn | ||
|
||
Using `yarn upgrade` or `yarn upgrade-interactive --latest` can produce errors | ||
with the latest version of yarn. This is commonly cited around the web, but | ||
using npx to one-off run an older version of yarn can fix this issues | ||
|
||
Example: | ||
|
||
``` | ||
npx [email protected] upgrade-interactive --latest | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.