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

Converting MultipleAlignments.Rnw to Rmarkdown #90

Open
wants to merge 9 commits into
base: devel
Choose a base branch
from

Conversation

BerylKanali
Copy link

@BerylKanali BerylKanali commented Dec 12, 2022

@jwokaty
Take a look at the changes
PDF and HTML for comparison
Issues I have:

    • In the description file when writing authors using this format
Authors@R: c(
  person("Hervé", "Pagès", role=c("aut", "cre"),

is it okay for the first name to be the intials as in the previous format.
2. Graph position not as exact as PDF
3. Size of graph(someone should not scroll to thee the whole graph)
6. The dev.off gives a different output when I knit

null device 
          1 

is the correct output but after in the HTML it shows

## png 
##   2

@jwokaty
Copy link
Contributor

jwokaty commented Dec 14, 2022

Let's follow the previous format using initials for the DESCRIPTION.

Looking at

\begin{figure}
\begin{center}
\includegraphics[width=0.6\textwidth]{goodTree}
\caption{\label{f2} A tree produced by using strings with masked gaps.}
\end{center}
\end{figure}
, I suspect that the original authors moved the figure to waste less space on the pages of the PDF. Let's allow the figures to follow their code naturally since the HTML document will not have the same problem.

Since the PDF isn't displaying as nicely as we'd like, I'd like to ask @hpages if we can change pdf to png instead? Or if there's a way to make the PDF display nicely, that suggestion would be helpful.

Lastly, I think we don't have to worry about the value of dev.off() as this is turning off the device and returning the value of that device I believe (we can check with ?dev.off). dev.off is always the "stub", which is null device 1, on the build system, which will generate the vignettes available on bioconductor.org. For users running this code, it will almost always show something else.

@BerylKanali BerylKanali marked this pull request as ready for review January 3, 2023 14:12
@BerylKanali
Copy link
Author

@jwokaty
This is ready for review apart from the graph issue talked about above. I did R CMD build and R CMD check and found no errors.

Copy link
Contributor

@jwokaty jwokaty left a comment

Choose a reason for hiding this comment

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

Thanks for working on this. I've marked a few items to correct; a few them, such as using back ticks (`) rather than asterisks (*) are repetitive but I marked them so that they can be checked again.

Before you ask for a review, make sure to review your knitted document against the current PDF that you find on the landing pages for each package.

@hpages Can we use .pngs for the figures rather than .pdfs since they don't format well? (If there's a better way to format them, please let us know.)

DESCRIPTION Outdated Show resolved Hide resolved
vignettes/MultipleAlignments.Rmd Outdated Show resolved Hide resolved
vignettes/MultipleAlignments.Rmd Outdated Show resolved Hide resolved
vignettes/MultipleAlignments.Rmd Outdated Show resolved Hide resolved
vignettes/MultipleAlignments.Rmd Outdated Show resolved Hide resolved
vignettes/MultipleAlignments.Rmd Outdated Show resolved Hide resolved
vignettes/MultipleAlignments.Rmd Outdated Show resolved Hide resolved
vignettes/MultipleAlignments.Rmd Outdated Show resolved Hide resolved
vignettes/MultipleAlignments.Rmd Outdated Show resolved Hide resolved
vignettes/MultipleAlignments.Rmd Outdated Show resolved Hide resolved
@hpages
Copy link
Contributor

hpages commented Jan 7, 2023

Can we use .pngs for the figures rather than .pdfs since they don't format well?

of course, thanks

@BerylKanali
Copy link
Author

@jwokaty I made the requested changes.
Updated HTML for comparison with PDF

@jwokaty jwokaty changed the title Converting MultipleAlinments.Rnw to Rmarkdown Converting MultipleAlingments.Rnw to Rmarkdown Jan 13, 2023
@hpages
Copy link
Contributor

hpages commented Jun 27, 2023

@BerylKanali @jwokaty Where are we standing with this PR?

@jwokaty
Copy link
Contributor

jwokaty commented Jun 27, 2023

I can check that the issues are resolved then notify @hpages.

@jwokaty jwokaty changed the title Converting MultipleAlingments.Rnw to Rmarkdown Converting MultipleAlignments.Rnw to Rmarkdown Jun 28, 2023
@jwokaty jwokaty requested a review from hpages June 28, 2023 13:41
@jwokaty
Copy link
Contributor

jwokaty commented Jun 28, 2023

@hpages This is ready for your review.

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.

None yet

3 participants