Git Product home page Git Product logo

admiralmetabolic's Introduction

pharmaverse website

pharmaverse.org

This website is maintained and governed by our website community. Further details of this are available here. The community lead is considered the product owner for the website and has final say on any decisions related to the website.

For any questions or enhancements for the site, please make issues at this repo.

Hosted sites:

This website is available at 2 locations:

Development / git flow

When you push to develop OR make a pull request onto develop a github action will run which will render the site, and deploy it to the test server. But the test server is different depending on which route you took.

The code on develop is hosted to: http://openpharma.s3-website.us-east-2.amazonaws.com/develop/

The intended workflows expects that develop is the UAT branch where you check things pre-prod. While the 'build from PR` allows you to work on something very experimental and check results, before pushing it do develop.

This git flow is predicated on it being unlikely to have more than one person actively working on the site at any one time.

You cannot work directly on main branch. The only way to push in is via a PR. And it will be denied if you have not come through develop. Any PR requires approval from one other Technology and Templates WG member.

Data flows

'Scraped' data

Passive data is collected via openpharma.github.io, a sister org that is completely un-opinionated and has
a wider remit spanning discovery to access. This site contains no curated data beyond names - and is instead focused on collecting and sharing data on open source health and related metadata (e.g. CRAN status and riskmetric scores).
Information on the data collected is here: https://openpharma.github.io/#data.

Data is stored in a pharmaverse AWS account.

Package info

Curated package info is stored in the folder data/. pharmaverse packages are in the folder data/packages. Non-pharma packages that get a special mention are in data/nonpharma. Each package is a unique .yaml file.

The general structure is:

name: admiral
repo: pharmaverse/admiral
repo_source: github.com
docs: https://pharmaverse.github.io/admiral/cran-release/
hex: https://github.com/insightsengineering/hex-stickers/raw/main/PNG/admiral.png
task: ADaM
details: (ADaM In R Asset Library) - Modular framework to generate ADaM via R functions relying on community contributions
splash: include # this controls what is shown on the main page. Plan is to deprecate and put all hex's up

It should be self explanatory. Please use the categories in the site for task:.

People

Info on people is in data/people. The yaml should be something like below, with the filename being the github handle.

name: James Black
pharmaverse_roles: tech
company: Roche
company_logo: roche.png
# Following is more a nice to have for profile pages [and optional]
linkedin: https://www.linkedin.com/in/epijim/
site: https://epijim.uk
title: People and Product Family Leader for Insights Engineering, Scientific Computing Environment Product Owner
bio: James is currently leading our pan-study codebase for insights

General content of the site

Site content is in content. It's normal markdown files. See markdown-guide.md.

Calling package info in the site

To call a package, we have two shortcuts. pharmaverse means it's 'pharmaverse' - e.g. in the folder data/packages. otherpackages is for non-pharmaverse packages, in data/nonpharma.

{{< pharmaverse pkg="rtables" >}}

{{< otherpackages pkg="gt" >}}

Council meeting minutes

From 2023 onwards, our monthly council meeting minutes will be published in static/council meeting minutes. Other static files such as images are stored in static also.

admiralmetabolic's People

Contributors

andersaskeland avatar manciniedoardo avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

biocyberman

admiralmetabolic's Issues

Update companies mentioned in LICENSE

Please select a category the issue is focused on?

No response

Let us know where something needs a refresh or put your idea here!

The License.md file needs to be updated so that the right companies (NN and Roche) are mentioned. See here how it was done in admiralpeds.

Updated admiralmetabolic website theme to match admiral theme

Please select a category the issue is focused on?

Other

Let us know where something needs a refresh or put your idea here!

Website theme currently looks like this:
image
Which does not match the admiral family theme:
image
Task is to identify where this is controlled (could it be in __pkgdown.yml?) and update. Might be good to compare files across the various admiral repos.

General Issue: Identify test data needs and start creating datasets

Background Information

See #5 to understand why we need test data. We will likely need to identify the initial focus areas (#7) for the package (#7) before we can understand what test data we need.

Follow the guidance from pharmaversesdtm as eventually we will move our test data out into this repo/package. If unsure of any conventions to follow, @manciniedoardo can advise.

Don't go overboard as this is only for driving the vignettes and templates so likely 5-10 patients should be enough.

Definition of Done

Some starter test data which we can build on over time, which can help address focus areas in #7.

Replace admiraltemplate placeholder text/images/code

Background Information

This repo has been generated from the admiraltemplate repo. Various placeholder files/images need to be updated with metabolic-specific counterparts.

Definition of Done

Update selected items in the followingg:

  • .Rbuildignore
  • .lycheeignore
  • DESCRIPTION
  • README.md
  • inst/WORDLIST
  • man/figures/logo.png
  • vignettes/admiraltemplate.Rmd
  • __pkgdown.yml
  • tests/testthat.R

Rename:

  • R/admiraltemplate-package.R
  • project file

General Issue: Identify initial focus areas for package

Background Information

See #5 to understand what we are looking for. Please put all your discussion there. Don't hold anything back!

Definition of Done

Clear focus areas identified - these could be:

  • Metabolic-specific ADaM datasets
  • Metabolic-specific derived parameters in standard ADaMs (eg. ADVS)
  • Metabolic-specific variables in standard ADaMs (eg. ADSL)

Update admiral version in DESCRIPTION file

Background Information

Currently, DESCRIPTION file records a dependency on admiral 1.1.0. But this version has a bug, and admiral 1.1.1 is due to release imminently. Once this happens, the DESCRIPTION file should be updated to point to it.

Definition of Done

Update DESCRIPTION file with following line admiral (>= 1.1.1) in place of existing one.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.