Command to include logo in package

[arthur-shaw]

Inspired by usethis::use_logo(), this adodown command could do some or all of the following:

• Provide some instructions on confirming the logo is the right dimensions/spec. Doubtful Stata could actually do the checking.
• Put the logo in the right place in the package file system. Still need to decide where that is, even if discussions seem to be favorable to assets dir in root of package. See lsms-worldbank/adodownr#6 and https://github.com/lsms-worldbank/labeller/issues/17
• Provide snippet for including logo in README. Ideally, this would simply be added to the README if not a dangerous operation. Alternatively, print the snippet to the console and provide link to further instructions.

Here's an example of the Markdown/HTML needed; here's the result of the example.

[kbjarkefur]

I am mostly concerned about getting a version of adodown out that does not crash.

Re confirming the logo is the right dimensions/spec.

• I do not see a single case for Stata loading the image. Only the R package would do that. Do you see a case for when Stata needs to handle the logo?
• What would happen if the picture does not have perfect dimensionas/specs? I think this should only test for things where the web documentation does not render. Any other case we should just allow to happen even if the logo is distorted or not even loading. With too much requirements it is annoying to get up and running.

Put the logo in the right place in the package file system

• Should the R package move the logo to the correct location? I have in mind that the Stata adodown package put the adodown hex image in the location we pick as a default to get the team up an running as quicklky as possible. Then the team can update that image whenever they are ready to do so to create their own branding.

• My preference for location is src/dev/assets but that is a weak preference and if you have a strong preference, lets just go with that

  including logo in README

Will this be for the web documentation as well? If not, then I think we can just write some documentation for how to do this, but not worrying about our R pacakge to do anything of that.

---

Let me know what you think!

[arthur-shaw]

Wups, it seems I put this issue in the wrong place. I'd meant for adodown to have a command for placing the image in the right place.

On the image location--agreed--let's go with src/dev/assets.

[arthur-shaw]

As an additional consideration, the image should be placed like this:

# pkg_name

<img src='src/dev/assets/logo.png' align="right" height="139" />

Avoid placing it like this (i.e., how it works in pkgdown), since doing so would put the image in the TOC of the Quarto site:

# pkg_name <img src='src/dev/assets/logo.png' align="right" height="139" />