Skip to content

Commit

Permalink
- Documentation changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Robert Hubley committed Sep 10, 2024
1 parent 3a85240 commit 0f36897
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 13 deletions.
5 changes: 4 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,9 @@ RUN cd /opt \
-default_search_engine=rmblast \
&& cd .. && rm src/RepeatMasker-4.1.6.tar.gz

## Get the RepeatMasker.lib from a full installation
## --and run makeblastdb

# Include config update
COPY tetoolsDfamUpdate.pl /opt/RepeatMasker/tetoolsDfamUpdate.pl

Expand All @@ -164,4 +167,4 @@ ENV PATH=/opt/RepeatMasker:/opt/RepeatMasker/util:/opt/RepeatModeler:/opt/Repeat
COPY container_test.sh /opt/
RUN chmod 701 /opt/container_test.sh
RUN /opt/container_test.sh | echo
RUN rm -r /opt/src
RUN rm -r /opt/src
28 changes: 16 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,17 +86,12 @@ singularity run dfam-tetools-latest.sif
### Customizing the RepeatMasker libraries
<!-- previous header name / link: --><a id="using-repbase-repeatmasker-edition"></a>

By default, RepeatMasker is only packaged with the root (0th) FamDB file. Details about
the contents of the files are available from the [FamDB repo](https://github.com/Dfam-consortium/FamDB)
and the files themselves are available to download from [Dfam.org](https://www.dfam.org/releases/Dfam_3.8/families/FamDB/)
Currently, RepeatMasker is installed without a TE library, however it will support
annotation with custom libraries (using the -lib mylib.fa command line option).

Additional setup is needed to install additional FamDB files and/or to install
RepBase RepeatMasker Edition for use with the container. This is a different
process from using a custom library of FASTA or HMM models, which can be
accomplished by using the `-lib` option to `RepeatMasker`.

Modifying the container can become a quite complex task, depending on which
software and versions are being used and how the system is configured. Instead
Additional setup is necesary to use TE libraries such as Dfam or RepBase for use
with the container. Modifying the container can become a quite complex task, depending on
which software and versions are being used and how the system is configured. Instead
these instructions will create a modifiable local `Libraries` folder that can be
mounted back into the container.

Expand All @@ -117,10 +112,19 @@ exit

# Make sure you own the Libraries folder
chown -R $USER ./Libraries/

# Remove the minimal famdb files
rm ./Libraries/famdb/*
```

To include additional FamDB files, download, unzip, and include them in `Libraries/famdb`.
They will be detected and included in queries automatically. Note that you will need a copy of the 0th partition in the host `Libraries` folder in addition to any addtitional files. It should be copied out of the container with above steps.
To include Dfam you will need to download one or more famdb partitions from
the Dfam site. The top level partition ( partition 0 ) will be necessary, however
additional partitions are optional. The contens of the partitions for the current
release can be found here [FamDB README](https://www.dfam.org/releases/current/families/FamDB/README.txt).
The partitions may be downloaded from here [Dfam.org](https://www.dfam.org/releases/current/families/FamDB/).

To include the Dfam FamDB files, download, unzip, and include them in `Libraries/famdb`.
They will be detected and included in queries automatically.

Whenever you modify the FamDB files, the RepeatMasker libraries must be regenerated.
```sh
Expand Down

0 comments on commit 0f36897

Please sign in to comment.